Sisältö
Mukaan lukien, jotta voit dokumentoida Pythonin perustettu-inside-lomakkeen enumerate(), luot sen ainakin yhdeksi lähdedatatiedostoistasi. Nyt kun sinulla on erityisiä datatiedostoja ja viestejä, luodaan ensimmäinen versio dokumenteista. Toimitettavat asiakirjat annetaan, koska asiakirjan nimet, mikä tarkoittaa, että poistut tiedostopäätteestä ja käytät send-vinoviivaa (/) indeksierottimina. Tämä voi olla yksi niistä kohdista, jotka Sphinx lisää reStructuredTextiin, joka on tapa yhdistää useita tietoja tiedostoista yhteen tikkaisiin. He loivat hyvän lähdehakemiston, jossa on conf.py, ja sinulle tulee juuritiedosto, directory.rst.
Suosituin yksikkö, jolla on asennuspaketteja pois PyPI:stä, ovat pip, jota käytetään Pythonin progressiivisissa versioissa. Tämä FairSpin -pelejä tulostaisi uusimman Sphinx-version määrän. Conf.py voi kuitenkin elää myös toisessa luettelossa, uudessa kokoonpanoluettelossa. Sphinx.ext.intersphinx, jossa on koko intersfinksin suosittujen ominaisuuksien erittely.
Jotta voit pelata intersphinxilla, sinun on käynnistettävä se conf.py-tiedostossa lisäämällä uusi sekvenssi “sphinx.ext.intersphinx” laajennusluetteloon ja asetettava intersphinx_mapping config-arvo. Sphinx auttaa sisällyttämään uusia dokumenttimerkkijonoja omista segmenteistäsi, joilla on laajennus (laajennuskokeile erinomaista Python-moduulia, joka tarjoaa uusia ominaisuuksia Sphinx-projektien omistamiseen), nimeltään autodoc. Uusi asiakirja yrittää tallentaa UTF-8:aan automaattisesti, kuten ensimmäisellä rivillä oleva koodausilmoitus osoittaa. Muista, että uusi tiedosto käyttää Python-lauserakennetta ketjun, numeroiden, hakemistojen ja niin edelleen omistamiseen. Mukauta hienoa konfiguraatiota, joka ei ole heti lisäbysphinx-quickstart, tee vain ylimääräinen tehtävä. Verkkotunnukset saatavilla oleville verkkotunnuksille ja niiden ohjeille/mahdollisuuksille.
Nämä voidaan suorittaa luomalla rakentajasi etiketille. (Ne voivat sisältää itse toctreedirectives, jotta voit aiheuttaa vakavasti sisäkkäisiä hierarkioita tarvittaessa.) Ja Sphinx ymmärtää nykyään oman datatiedostojen hankinnan ja hierarkian. Tältä todella näyttää tämän paperityön puu. Jokainen direktiivi määrittää, sallitaanko sen olla blogeja, ja sinä valitset, mihin suuntaan siinä mennään.
![]()
Tämä voidaan tehdä niin, että kaikki pdf-totuus kerrotaan siellä. Jos haluat yhdistää kaksi vinkkiäsi yhteen, pidä hauskaa sfinksi-make -M:llä (we.elizabeth. -Yards latexpdf ei -b latexpdf) tai rakenna lateksipdf-paneeleillasi. Se, että it builder tuottaa samanlaista tuottavuutta, kun taas itsenäinen HTML-luoja, mutta tekee myös innostuneen epub-julkaisun e-kirja-asiakkaiksi. Se Builder tarjoaa identtisen tuottavuuden, koska se on erillinen HTML-luoja, mutta tekee myös GNOME Devhelp-tukiasiakirjan, jonka avulla upouusi GNOME Devhelp -katseluohjelma pääsee niihin.
Toctree on hyvä reStructuredText-direktiivi, erittäin joustava merkintä. Minkä tiedoston tarkoituksena on saada sinut nauttimaan siitä, mitä Sphinx yrittää ja miten voit käyttää sitä.
Muiden suolakurkkutietojen sijasta niin se suolakurkkutiedosto tekee välttämättömäksi, että uusin sfinx-paketti voidaan hankkia poistoa varten. Tämä voi olla jatkuvasti Builderista riippumaton suolakurkkutiedosto ja voit olla kopio ekosysteemistäsi, joka laitettiin, jos builder käynnistettiin. Alla olevan resurssiasiakirjan nimi _supply.

Jos joku tekee tällaisista tiedostoista löydettävissä koodisi locale_dirs-sovelluksella, Sphinx saa ne välittömästi. Sphinx purkaa nämä sphinx-make -M gettextin kutsumisen vuoksi. Se kaavioi naiivisti sovelluksen sisällä olevat viestit käännetyksi sekvenssiksi. Sphinx käyttää tämäntyyppisiä instituutioita, jotta voit muuttaa kokonaisia datatiedostoja. Sphinx auttaa sinua käännöksissä, jotka on lähetetty Sphinxin tuottamiin teksteihin, mukaan lukien navigointipubeihin, ja tuo mukanaan elementtejä, jotka helpottavat uusimpien asiakirjojen kääntämistä. Luettelo, joka piti hallussaan uusia levyjä.
Voit hyödyntää omaa verkkopalvelintasi Sphinx HTML -paperityössäsi. Se on ratkaisu, joka tarjoaa enemmän vapautta ja myös paljon vaikeampaa. Lue asiakirjoja kokeile online-palveluntarjoajaa, joka keskittyy pitämään Sphinxillä kirjoitettua teknistä dokumentaatiota MkDocsin ohella. Siellä on erinomainen Sphinx-tulkintasivu, jolla on Sfinksi- (pää)paperitöitä.