Jotta Pythonin perusta dokumentoitaisiin muodossa enumerate(), se luotaisiin yhteen lähdetiedostoistasi. Nyt kun sinulla on erityisiä tiedostoja ja olet tyytyväinen, luodaan ensimmäinen rakenne dokumenttien pohjalta. Sisällytettävät tiedostot annetaan tiedostonimissä, mikä tarkoittaa lyhyesti sanottuna sitä, että hyppäät pois tiedostopäätteestä ja käytät kauttaviivoja (/) luetteloerottimina. Tämä on yksi Sphinxin lisäämistä ominaisuuksista reStructuredTextiin, menetelmään, jolla useita tiedostoja yhdistetään yhteen tietohierarkiaan. Se loi hyvän lähdehakemiston, jossa on conf.py, ja päätiedoston, directory.rst.

Rebellion casino kirjautuminen rekisteröinti – Rakentajat¶

Tunnetuin työkalu pakettien asentamiseen PyPI:stä on pip, joka sisältyy kaikkiin progressiivisiin Pythonin tuotemerkkeihin. Tämä tulostaa uusimman Sphinx-variaation määrän. conf.py voi kuitenkin myös tulostaa reaaliajassa toisessa luettelossa, uusimman kokoonpanoindeksin. Sphinx.ext.intersphinx, jos haluat täydellisen kuvauksen intersphinx-ominaisuuksista.

Tutkiaksesi intersphinxiä sinun on käynnistettävä se conf.py-tiedostossa lisäämällä uusin merkkijono 'sphinx.ext.intersphinx' laajennusluetteloosi ja sijoittamalla se intersphinx_mapping-konfiguraatioarvoon. Sphinx tukee docs-merkkijonojen lisäämistä segmentteihin, joilla on laajennus (laajennus, joka tarjoaa uusia ominaisuuksia Sphinx-projekteille) nimeltä autodoc. Uusi tiedosto tallennetaan automaattisesti UTF-8-muotoon, kuten ensimmäisellä rivillä olevasta koodausilmoituksesta näkyy. Muista, että uusin tiedosto käyttää Python-syntaksia ketjun, lukujen, luetteloiden jne. lisäämiseen. Jos haluat mukauttaa konfiguraatioarvoa, joka ei ole automaattisesti uusi, lisää vain uusi projekti. Domains kaikille saatavilla oleville verkkotunnuksille ja niiden direktiiveille/positioille.

Varhaisin asetus¶

Näitä voidaan suorittaa suorittamalla make-komentosarja rakentajan ajan. (Ne voivat sisältää itse toctree-direktiivejä, mikä tarkoittaa, että voit luoda tarvittaessa sisäkkäisiä hierarkioita.) Lisäksi Sphinx ymmärtää nykyään tiedostojesi järjestyksen ja hakemiston. Näin toctree-dokumentaatio näyttää. Jokainen direktiivi päättää, sallitaanko se blogien luomisen ja miten siinä edetään.

Conda-paketti¶

Voit tehdä tämän itse asiassa komennolla make all-pdf. Yhdistääksesi kaksi proseduuria Rebellion casino kirjautuminen rekisteröinti yhdellä, kokeile komennolla sphinx-generate -M(i.elizabeth. -Meters latexpdf ei -b latexpdf) tai generate latexpdf projektin juuressa. Joten it creator tarjoaa samanlaisen sisällön kuin itsenäinen HTML-kehittäjä, mutta luo myös aktiivisen epub-tiedoston gigantin tilaajille. Tämä it creator tarjoaa samanlaisen sisällön kuin itsenäinen HTML-rakentaja, mutta luo myös GNOME Devhelp -tukitiedoston, jonka avulla uusi GNOME Devhelp -käyttäjä voi osallistua siihen.

Toctree on itse asiassa reStructuredText-direktiivi, erittäin joustava merkintäjärjestelmä. Sen tarkoituksena on antaa sinulle välitön kuva siitä, mitä Sphinx oikeastaan ​​on ja miten sitä voidaan käyttää.

Asennus pois toimituslähteen läheltä¶

Toisin kuin jotkut muut pickle-tiedostot, pickle-tiedosto edellyttää, että uusi sphinx-paketti on saatavilla purkamista varten. Tämä on yleensä hyvä pickle-tiedosto, erillään rakentajasta, ja se voi olla kopio omasta ympäristöstäsi, joka luotiin rakentajan käynnistyksen yhteydessä. Lähdetiedoston nimi on alle _offer.

Jos teet tällaiset tiedostotyypit löydettävissä käyttämällä sanastollesi locale_dirs-asetusta, Sphinx hakee ne automaattisesti. Sphinx poimii nämä kutsumalla sphinx-make -Yards gettext. Ne yhdistävät ohjelman sisällä olevat viestit naiivisti muunnettuun merkkijonoon. Sphinx käyttää tällaisia ​​organisointitapoja muuttaakseen kokonaisia ​​tiedostoja. Sphinxin tuottamien tekstien, kuten navigointipubsien, käännöksiä täydentäen Sphinx tarjoaa järjestelmiä, jotka helpottavat asiakirjojen uusien käännösten tekemistä. Luettelo, jota voit käyttää uusien asiakirjojen etsimiseen.

Sarjalistuksen luojan tiedot¶

Voit käyttää omaa verkkokonettasi Sphinx HTML -dokumenttien isännöintiin. Se on ratkaisu, joka tarjoaa paljon enemmän vapautta, mutta myös paljon enemmän monimutkaisuutta. Investigate Docs on itse asiassa verkkopalvelu, joka on omistettu Sphinxillä kirjoitettujen teknisten dokumenttien, mukaan lukien MkDocs, isännöintiin. Löydät Sphinx-käännössivuston Sphinx (pää)dokumenteille.