Artikkelit
Jotta voit dokumentoida Pythonin based-inside-lomakkeen enumerate(), lisäät sen johonkin lähdetiedostoistasi. Nyt kun sinulla on erityistä dataa ja haluat julkaista sitä, tehdään ensimmäinen esitys dokumenteista. Sisällytettävät tiedostot annetaan tiedostotunnisteina, mikä lyhyesti sanottuna tarkoittaa, että kirjaudut ulos tiedostonimen laajennuksesta ja käytät kauttaviivoja (/) indeksierottimina. Tämä on yksi Sphinxin lisäämistä ominaisuuksista reStructuredTextiin, tapoja yhdistää useita tiedostoja yhdeksi datatiedostojen portaaksi. Se on luonut hyvän lähdetiedostohakemiston, jossa on conf.py, ja juuritiedoston, directory.rst.
Rakentajat¶ | miten nostaa BigWins bonus
Suosituin työkalu miten nostaa BigWins bonus pakettien asentamiseen PyPI:n ulkopuolelle on pip, jota käytetään kaikissa Pythonin progressiivisissa versioissa. Tämä tulostaa uuden Sphinx-sovitusarvon. Vaikka ei, conf.py voi sijaita myös toisessa indeksissä, uusien asetusten luettelossa. Sphinx.ext.intersphinx intersphinx-ominaisuuksien kaikkien ongelmien ratkaisemiseksi.
Jotta voit tutkia intersphinxiä, sinun on aktivoitava se conf.py-tiedostossa lisäämällä uusin merkkijono 'sphinx.ext.intersphinx' laajennusluetteloosi ja asettamalla intersphinx_mapping-konfiguraatioarvon. Sphinx tukee uusimpien dokumenttimerkkijonojen lisäämistä omista moduuleistasi, joilla on laajennus (Python-moduuli, joka antaa uusia ominaisuuksia Sphinx-projekteillesi) nimeltä autodoc. Uusi asiakirja tallennetaan automaattisesti UTF-8-muotoon, kuten ensimmäisen rivin koodausilmoituksessa ilmoitetaan. Muista, että uusi tiedosto käyttää Python-syntaksia ketjulle, numerolle, listauksille jne. Voit mukauttaa hyvän konfiguraatioarvon, joka ei ole automaattisesti lisättävissä sphinx-quickstartissa, asettamalla vain uuden projektin. Domains kaikille tarjotuille verkkotunnuksille ja niiden direktiiveille/positioille.
Perusjärjestely¶
Nämä voidaan tehdä ajamalla build oman rakentajasi nimilistalle. (Ne voivat sisältää itse toctree-direktiivejä, joten voit tarvittaessa luoda sisäkkäisiä hierarkioita.) Ja Sphinx ymmärtää nykyään datasi buildin ja voit luoda ladderin. Näin toctree näyttää tässä dokumentissa. Jokainen direktiivi määrittää, onko se sisällöltään tarkka, ja miten edetä.
Conda-paketti¶
Voit tehdä tämän komennolla "make all the-pdf" siellä. Yhdistääksesi kaksi proseduuria yhdeksi, kokeile komennolla "sphinx-generate -M" (eli "-M latexpdf", ei "-b latexpdf") tai "build latexpdf" paneelien juuressa. Joten it builder tarjoaa saman tuotoksen kuin itsenäinen HTML-rakentaja, mutta luo myös avoimen lähdekoodin e-kirjalukijoille. Joten it builder tarjoaa samanlaisen tulosteen kuin itsenäinen HTML-luontiohjelma, mutta luo myös GNOME Devhelp -tukitiedoston, jonka avulla uusi GNOME Devhelp -lukija voi käyttää sitä.
Toctree on hyvä reStructuredText-direktiivi, erittäin monipuolinen merkintätyökalu. Tämän asiakirjan tarkoituksena on tehdä sinulle yksinkertainen valinta siitä, mitä Sphinx oikeastaan on ja miten voit käyttää sitä.
Määritä lähdekoodin ulkopuolelta¶
Toisin kuin lisäpikkelitiedostot, pickle-dokumentti vaatii, että uusi sphinx-paketti on saatavilla purkamista varten. Tämä on todella hyvä pickle-dokumentti, joka on riippumaton rakentajasta, ja saat kopion omasta ympäristöstäsi, joka luotiin, jos luoja käynnistettiin. Lähdedokumentin otsikko alla _provide.
Jos teet tällaisista tiedostoista löydettäviä, joilla on kielellesi area_dirs, Sphinx poimii ne välittömästi. Sphinx poimii ne kutsumalla sphinx-generate -Meters gettext. Se naiivisti yhdistää ohjelman tekstit muunnettuun merkkijonoon. Sphinx käyttää tällaista työtä auttaakseen sinua muuttamaan kokonaisia tietoja. Sphinxin tuottamien tekstien, kuten navigointitiedostojen, käännösten tukemisen lisäksi Sphinx tarjoaa elementtejä, jotka helpottavat asiakirjojen uutta tulkintaa. Kokoelma, jota voidaan käyttää uusien asiakirjojen etsimiseen.
Sarjalistuksen luojan tiedot¶
Voit aina käyttää omaa online-konettasi Sphinx HTML -dokumenttien palvelimiseen. Se on vaihtoehto, joka tarjoaa paljon enemmän itsenäisyyttä ja monimutkaisuutta. Investigate Docs on internet-palvelu, joka on erikoistunut Sphinxillä painettujen teknisten asiakirjojen sekä MkDocs-tiedostojen säilyttämiseen. Löydät erinomaisen Sphinx-tulkintasivuston Sphinx (master) -tiedostoille.
