Esimerkiksi, jotta voit dokumentoida Pythonin keskitetyn tilan enumerate() sisällä, sisällytät sen 1:een lähdetiedoistasi. Nyt kun sinulla on erityisiä datatiedostoja ja artikkeleita, luodaan asiakirjojen ensisijainen merkki. Lisättävät asiakirjat toimitetaan tiedostonimien perusteella, mikä tarkoittaa lyhyesti, että hyppäät pois asiakirjan identiteetin laajennuksesta ja harjoittelet vinoviivaa (/) indeksien erottimista lähtien. Tämä on todellakin yksi tärkeimmistä kohdista, jonka Sphinx lisää reStructuredText, keino yhdistää useita datatiedostoja vähintään yhteen tiedostohierarkiaan. He loivat erinomaisen lähdehakemiston, jossa on conf.py ja sinulla voi olla juuridokumentti, index.rst.
IWinFortune virallinen sovellus – Rakentajat¶
Tunnetuin PyPI:n asennuspaketteja sisältävä yksikkö on pip, jota käytetään kaikissa nykyaikaisissa Python-tyypeissä. Tämä tulostaa uuden sfinksityypin määrän. Mutta ei, conf.py saattaa elää toisessa luettelossa, upouudessa määrityshakemistossa. Sphinx.ext.intersphinx intersfinksin ominaisuuksien täydelliseen toimintahäiriöön.
Auttaaksesi pelaamaan intersphinxilla, sinun tulee käynnistää se conf.py-tiedostossa lisäämällä uusi merkkijono „sphinx.ext.intersphinx“ laajennusluetteloon ja määrittämällä intersphinx_mapping configworth. Sphinx tukee uutta dokumenttimerkkijonojen lisäämistä omista segmenteistäsi, joissa on laajennus (laajennus on Python-moduuli, joka antaa lisäominaisuuksia Sphinx-projekteihin) nimeltä autodoc. Tuore tiedosto tallennetaan UTF-8:aan automaattisesti, koska se näkyy koodausilmoituksesta 1. alueella. Ymmärrä, että uusin tiedosto käyttää Python-syntaksia omistaakseen merkkijonoja, numeroita, luetteloita ja niin edelleen. Mukauta hieno konfiguraatio, joka ei ole automaattisesti ylimääräinen bysphinx-quickstart, vaan laita ylimääräinen projekti. Verkkoalueet kaikille saatavilla oleville verkkotunnuksille niiden ohjeiden/tehtävien lisäksi.
Varhaisin kokoonpano¶
Nämä voidaan suorittaa ajamalla makea luojan toimikaudeksi. (Ne voivat iWinFortune virallinen sovellus sisällyttää itse toctreedirectives, jotta voit luoda syvälle sisäkkäisiä hierarkioita tarvittaessa.) Samoin Sphinx ymmärtää nyt ostamisesta ja sinä vaiheet omista tiedoistasi. Tämä on toctre, koska se näyttää tiedostot. Jokainen direktiivi päättää, sallitaanko se olla blogeja vai ei, ja sinä valitset, kuinka käsitellä sitä.
Conda nippu¶
Voit tehdä tämän kautta tehdä kaikki pdf-tiedostot siellä. Jos haluat yhdistää kaksi vaihetta vain yhdelle, pidä hauskaa komennolla sphinx-create -M(i.age. -Yards latexpdf ehkä ei -b latexpdf) tai tee lateksipdf-projektin resursseista. Että it builder tuottaa vertailukelpoisen tuloksen, koska itsenäinen HTML builder, mutta luo myös innokkaan epub-sovelluksen opasasiakkaille. Että it Builder tarjoaa vertailukelpoisen tuotannon, koska erillinen HTML-muodostin, mutta tuottaa myös GNOME Devhelpsupport -tiedoston, jonka avulla uusin GNOME Devhelp -yleisö voi katsella häntä.
Toctree on hyvä reStructuredText-direktiivi, erittäin joustava merkintä. Tämän asiakirjan tarkoituksena on saada sinut nopeasti valitsemaan mitä Sphinx yrittää ja miten voit käyttää sitä.
Tarvikkeiden asennus¶
Toisin kuin muut suolakurkkutiedostot, se vaatii, että tuore sfinx-paketti on poimintasi käytettävissä. Tämä on aina loistava suolakurkkutiedosto, joka on erillään thebuilderista ja voit kopioida ympäristön, jota oli käytetty siinä tapauksessa, että luoja käynnistettiin. Toimitusasiakirjan nimi, joka on pienempi kuin _lähde.
Jos joku tekee sellaisista tiedostoista löydettävissä, joissa koodillesi on area_dirs, Sphinx saa ne automaattisesti. Sfinksi poimii nämä kutsumisen vuoksi pois sfinksi-luo -Yards gettextistä. Se kartoittaa naiivisti sovelluksen tekstit käännetyksi sekvenssiksi. Sphinx käyttää tämän tyyppistä organisaatiota auttaakseen sinua kääntämään kokonaisia asiakirjoja. Täydentävä, jotta voit toimittaa käännöksiä Sphinxin tuottamiin viesteihin, esimerkiksi navigointipubeihin, Sphinx tuo mukanaan elementtejä, jotka auttavat dokumenttien aivan uutta tulkintaa. Hakemistossa näkyi uudet paperityöt.
Sarjamuodostuksen tekijän faktat¶
Voit käyttää yksittäisiä online-palvelimia, jotta voit koneistaa Sphinx HTML -tiedostoja. Yksinkertainen tosiasia on, että vaihtoehto antaa paljon enemmän vapautta ja paljon enemmän vaikeuksia. Browse the Docs on Internet-palvelu, joka on erikoistunut Sphinx-kielellä kirjoitetun teknisen dokumentaation säilyttämiseen MkDocsin ohella. Siellä on varmasti erinomainen Sphinx-tulkintasivu Sphinx-paperityötä varten.
Komfort
Immer für Sie da
