Esimerkiksi Pythonin riippuvaisen sisäisen asetuksen enumerate() dokumentoimiseksi luot sen ainakin yhteen lähdetiedostoistasi. Nyt kun sinulla on tarkempaa tietoa ja voit julkaista, tehdään ensimmäinen tiedosto dokumenteista. Sisällytettävät tiedostot ovat tiedostotunnisteiden mukaisia, mikä lyhyesti sanottuna tarkoittaa, että ne erotetaan tiedostonimen päätteestä ja käytetään kauttaviivoja (/) luetteloerottimina. Tämä on yksi Sphinxin reStructuredText-ominaisuuksista, joka mahdollistaa useiden datatiedostojen yhdistämisen yhteen hierarkiaan datatiedostojen ulkopuolella. He kirjoittivat hyvän lähdetiedostohakemiston conf.py-tiedostolla ja juuritiedostolla index.rst.

Kasinobonukset kasino: Rakentajat¶

Tyypillisesti suosituin yksikkö pakettien asentamiseen PyPI:stä on pip, joka löytyy kaikista Pythonin progressiivisista versioista. Tämä tulostaa uuden Sphinx-tyyppinumeron. Mutta conf.py saattaa olla myös toisessa luettelossa, uusimmassa kokoonpanoluettelossa. Sphinx.ext.intersphinx intersphinx-ominaisuuksien kaikkien ongelmien ratkaisemiseksi.

Jotta intersphinxin kanssa leikkiminen olisi helpompaa, kannattaa ottaa ne käyttöön conf.py-tiedostossa lisäämällä uusimman Kasinobonukset kasino sekvenssin 'sphinx.ext.intersphinx' extensionslist-luetteloon ja asettamalla intersphinx_mapping-konfiguraatioarvo. Sphinx tukee uusien dokumenttimerkkijonojen sisällyttämistä segmentteihin, joilla on autodoc-laajennus (laajennus on erinomainen Python-moduuli, joka tarjoaa uusia ominaisuuksia Sphinx-projekteille). Uusi tiedosto tallennetaan automaattisesti UTF-8-muotoon, koska se ilmaistaan ​​encodingdeclarationilla ensimmäisessä osassa. Muista, että uusin tiedosto käyttää Pythonin lauserakennetta merkkijonoille, luvuille, luetteloille jne. Voit mukauttaa hyvän konfiguraatioarvon, joka ei ole automaattisesti uusi, sphinx-quickstart-komennolla, asettamalla vain uuden projektin. Domains kaikille käytettävissä oleville verkkotunnuksille ja niiden direktiiveille/positioille.

Perusasetukset¶

Nämä voidaan tehdä suorittamalla build to your identity of creator. (Ne voivat sisältää itse toctree-direktiivejä, tai voit tarvittaessa luoda syvästi sisäkkäisiä hierarkioita.) Lisäksi Sphinx tietää nyt tiedostojesi buildin ja voit tehdä muita vaiheita. Näin tämän tiedoston toctree näyttää. Jokainen direktiivi määrittää, onko se tiedostoissa ja miten sitä käsitellään sen sisällä.

Conda-sopimus¶

Kasinobonukset kasino

Voit tehdä tämän komennolla make all-pdf siellä. Yhdistääksesi kaksi vaihetta yhdeksi, kokeile komennolla sphinx-generate -M(eli -M latexpdf ei -b latexpdf), muuten generate latexpdf projektin juuressa. Sen rakentaja tarjoaa saman tuottavuuden kuin erillinen HTML-luontiohjelma, mutta luo myös hienostuneen epub-julkaisutiedoston jäsenille. Sen rakentaja tarjoaa saman tulosteen kuin erillinen HTML-luontiohjelma, mutta luo myös GNOME Devhelp -tukitiedoston, jonka avulla uusi GNOME Devhelp -käyttäjä voi tarkastella sitä.

Toctree on itse asiassa reStructuredText-direktiivi, uskomattoman joustava merkintämuoto. Sen tarkoituksena on antaa sinulle yksinkertainen käsitys siitä, mitä Sphinx-koodit ovat ja miten niitä voidaan käyttää.

Asennus pois lähteestä¶

Toisin kuin jotkut muut pickle-tiedostot, tämä pickle-tiedosto edellyttää, että uusi sphinx-paketti on saatavilla purkamista varten. Se on yleensä erinomainen pickle-tiedosto, joka on riippumaton rakentajasta, ja saat kopion ekosysteemistä, jota käytettiin, jos rakentaja käynnistettiin. Resurssitiedoston nimi alla _offer.

Jos teet löydettävissä olevia tiedostoja, joilla on koodille location_dirs, Sphinx poimii ne välittömästi. Sphinx poimii nämä kutsumalla pois sphinx-generate -M gettext -komennosta. He naiivisti mappaavat viestit ohjelman sisällä, jotta löydät käännetyn merkkijonon. Sphinx käyttää tällaisia ​​​​määrityksiä auttaakseen sinua muuttamaan koko dataa. Täydentäen Sphinxin tekemien viestien, kuten navigointipalkkien, käännöksiä, Sphinx tarjoaa mekanismeja, jotka auttavat uusien asiakirjojen kääntämisessä. Hakemisto, jota voidaan käyttää uusien asiakirjojen etsimiseen.

Sarjallistamisen rakentajan tiedot¶

Kasinobonukset kasino

Voit aina käyttää omia internet-palvelimiasi Sphinx HTML -dokumenttien palvelimien tarjoamiseen. Yksinkertainen tosiasia on, että tämä ratkaisu tarjoaa sinulle enemmän itsenäisyyttä, mutta myös enemmän vaikeuksia. Investigate Docs on verkkopalvelu, joka keskittyy Sphinxillä kirjoitettujen teknisten asiakirjojen ja MkDocs-dokumenttien ylläpitoon. Sphinx-tulkintasivustolla on Sphinx (pää)dokumentit.

Recommended Posts