Esimerkiksi Pythonin sisäisen enumerate()-funktion dokumentoimiseksi sisällyttäisit which-funktion yhteen lähdetiedostoistasi. Nyt kun sinulla on tarkempia datatiedostoja ja sisältöä, luodaan dokumenttien alustava generointi. Tarjottavat dokumentit annetaan dokumenttien nimien yhteydessä, mikä lyhyesti sanottuna tarkoittaa, että poistut tiedostopäätteestä ja harjoittelet vinoviivoja (/) luetteloerottimina. Tämä on yksi Sphinxin lisäämistä tavoista yhdistää useita tietoja yhteen vaiheeseen datan ulkopuolella. He ovat luoneet erinomaisen lähdehakemiston, jolla on conf.py, ja voit luoda juuritiedoston, list.rst.

Rakentajat¶: napsauta sivustoa

Suosituin työkalu pakettien asentamiseen PyPI:stä on pip, jota käytetään Pythonin moderneissa versioissa. Tämä tulostaa uuden Sphinx-tyyppisen tiedoston. Mutta ei, conf.py voi myös tulostaa reaaliajassa toisessa luettelossa, uusimmassa kokoonpanoluettelossa. Sphinx.ext.intersphinx intersphinx-ominaisuuksien kaikkien toimintahäiriöiden varalta.

Leikkiäksesi intersphinxin kanssa, sinun on käynnistettävä se conf.py-tiedostossa lisäämällä uusi merkkijono 'sphinx.ext.intersphinx' extensionslist-luetteloon ja asettamalla intersphinx_mapping-konfiguraatioarvo. Sphinx tukee uusien docs-merkkijonojen lisäämistä segmenteistäsi, joilla on laajennus (laajennus napsauta sivustoa on Python-moduuli, joka tarjoaa uusia ominaisuuksia Sphinx-projekteille) nimeltä autodoc. Uusi tiedosto tallennetaan oletusarvoisesti UTF-8-muodossa, kun taas encodingdeclaration välittää sen ensimmäisessä osassa. Muista, että uusi tiedosto käyttää Python-lauserakennetta merkkijonoille, numeroille, listauksille jne. Jos haluat mukauttaa hyvän konfiguraation, joka ei ole välittömästi uusi, Sphinx-pikakäynnistyksen avulla, luo vain uusi tehtävä. Domains kaikille käytettävissä oleville domaineille sekä niiden direktiiveille/tehtäville.

Perusasetukset¶

Nämä voidaan tehdä ajamalla build oman rakentajan nimellä. (Ne voivat itse sisältää toctree-direktiivejä, voit tarvittaessa luoda vakavasti sisäkkäisiä hierarkioita.) Lisäksi Sphinx tietää nyt tiedostojesi tason ja ladderin. Tämä on toctree, jota se käyttää ulkoasujen tallentamiseen. Jokainen direktiivi määrittää, onko se blogien tyyssija, ja miten siinä edetään.

Conda-paketti¶

Voit tehdä tämän komennolla make all-pdf siellä. Yhdistääksesi kaksi proseduuria yhteen, kokeile komennolla sphinx-make -M (eli -Yards latexpdf, ei ehkä -b latexpdf), tai luo latexpdf projektin juuressa. Sen luontityökalu tarjoaa samanlaisen tulosteen kuin itsenäinen HTML-luontityökalu, mutta luo myös avoimen lähdekoodin e-kirjan tilaajille. Tämä luontityökalu tarjoaa samanlaisen tulosteen kuin itsenäinen HTML-luontityökalu, mutta luo myös GNOME Devhelp -tukitiedoston, jonka avulla uusi GNOME Devhelp -lukija voi tarkastella sitä.

Toctree on itse asiassa reStructuredText-direktiivi, uskomattoman monipuolinen merkintäjärjestelmä. Sen tarkoituksena on antaa sinulle nopea käsitys siitä, mitä Sphinx on ja miten sitä voisi käyttää.

Määritä lähteestä¶

Toisin kuin muut pickle-tiedostot, pickle-tiedosto vaatii, että uusi sphinx-paketti on ladattavissa purkamiseen. Tämä on aina erinomainen pickle-tiedosto, erillinen rakentajasta, ja sinulla on kopio ympäristöstäsi, joka on ladattu, jos luoja käynnistettiin. Lähdetiedoston nimi on _offer.

Jos teet näistä tiedostoista löydettäviä ja sinulla on sanallesi area_dirs, Sphinx poimii ne automaattisesti. Sphinx poimii ne kutsumalla pois sphinx-make -M gettext -komennosta. He luovat naiivisti kaavioita kurssin teksteistä, jotta löydät käännetyn sekvenssin. Sphinx käyttää tätä toimintoa auttaakseen sinua muuttamaan kokonaisia ​​tiedostoja. Täydentäen käännöksiä Sphinxin tekemiin viesteihin, kuten navigointipalstoihin, Sphinx tarjoaa elementtejä, jotka helpottavat asiakirjojen uutta käännöstä. Luettelo, jota voidaan käyttää uusimpien asiakirjojen etsimiseen.

Sarjallistamisen rakentajan tiedot¶

Voit aina käyttää omaa verkkopalvelinta Sphinx HTML -dokumentaation työstämiseen. Tosiasia on, että tämä vaihtoehto tarjoaa enemmän vapautta, mutta myös enemmän vaikeuksia. Lue dokumentaatio ja kokeile verkkopalvelua, joka on erikoistunut Sphinxillä kirjoitetun teknisen dokumentaation, kuten MkDocsin, ylläpitoon. Sphinx (master) -dokumentaatiolle on olemassa Sphinx-käännössivusto.