Artikkelit
Jotta voisit dokumentoida Pythonin riippuvaisen Mega Moolah-kolikkopeli pelaa oikealla rahalla sisäisen funktion enumerate(), lisäät sen ainakin yhteen lähdetiedostoistasi. Nyt kun olet lisännyt joitakin dokumentteja ja artikkeleita, luodaan dokumenttien ensisijainen kopio. Lisättävät dokumentit annetaan dokumenttien niminä, mikä lyhyesti sanottuna tarkoittaa, että poistut dokumentin päätteestä ja käytät kauttaviivoja (/) indeksierottimina. Tämä on yksi Sphinxin lisäämistä reStructuredText-tiedostosta, joka yhdistää useita tiedostoja yhteen datavaiheeseen. Se loi erinomaisen lähdehakemiston, jossa on conf.py ja juuritiedosto index.rst.
Rakentajat¶ – Mega Moolah-kolikkopeli pelaa oikealla rahalla
Yleisimmin käytetty työkalu PyPI-pakettien asentamiseen on pip, jota käytetään Pythonin moderneissa versioissa. Tämä tulostaa uusimman Sphinx-tyyppinumeron. Mutta ei, conf.py saattaa toimia myös toisessa indeksissä, uusien asetusten luettelossa. Sphinx.ext.intersphinx on tiedostoja, jotka sisältävät täydellisen kuvauksen intersphinxin suosituimmista ominaisuuksista.
Jotta voit pitää hauskaa intersphinxin kanssa, sinun kannattaa ottaa se käyttöön conf.py-tiedostossa lisäämällä uusi merkkijono 'sphinx.ext.intersphinx' extensionslist-luetteloon ja asettamalla sen intersphinx_mapping-konfiguraatioarvoon. Sphinx tukee uusien docs-merkkijonojen käyttöönottoa segmenteistäsi laajennuksella (laajennus on hyvä Python-moduuli, joka antaa uusia ominaisuuksia Sphinx-projekteille) nimeltä autodoc. Uusi tiedosto on oletusarvoisesti UTF-8-koodattu, koska se välitetään ensimmäisen alueen koodausilmoituksen kautta. Huomaa, että uusi tiedosto käyttää Python-lauserakennetta ketjulle, numeroille, luetteloille jne. Jos haluat mukauttaa konfiguraatioarvoa, joka ei ole suoraan lisättävissä sphinx-quickstartilla, lisää vain uusi määritys. Domains kaikille saatavilla oleville verkkotunnuksille ja niiden direktiiveille/kohdille.
Ensimmäinen määritys¶
Nämä voidaan tehdä ajamalla create-komento luojan identiteetille. (Ne voivat sisältää omia toctree-direktiivejä, jotta voit tarvittaessa luoda syvästi sisäkkäisiä hierarkioita.) Lisäksi Sphinx ymmärtää nyt tiedostojesi järjestyksen ja vaiheet. Näin toctree-tiedostot näyttävät. Jokainen direktiivi määrittää, sallitaanko se blogien luominen ja miten sitä käsitellään siinä.
Conda-sopimus¶
Voit tehdä tämän komennolla "make all the-pdf" siellä. Yhdistääksesi kaksi toimintoa vain yhteen, kokeile komentoa sphinx-build -M(i.age. -Yards latexpdf, ei ehkä -b latexpdf) tai "create latexpdf" projektin lähdekoodissa. Joten sen luontityökalu tarjoaa saman suorituskyvyn kuin itsenäinen HTML-luontityökalu, mutta luo myös kiinnostavan epub-tiedoston e-kirjan lukijoille. Tämä luontityökalu tarjoaa saman suorituskyvyn kuin itsenäinen HTML-rakentaja, mutta luo myös GNOME Devhelp -tukitiedoston, jonka avulla uusi GNOME Devhelp -käyttäjä voi käyttää sitä.
Kokeile Toctreessa hyvää reStructuredText-direktiiviä, joka on erittäin monipuolinen merkintätyökalu. Soit-tiedoston tavoitteena on antaa sinulle yksinkertainen esimaku siitä, mitä Sphinx oikeastaan on ja miten sitä voisi käyttää.
Osamaksu pois toimituksesta¶
Muiden pickle-tiedostojen sijaan pickle-tiedosto edellyttää, että uusi sphinx-paketti on ladattavissa purkamista varten. Tämä on yleensä erinomainen pickle-tiedosto, erillinen rakentajasta ja kopiosta ympäristöstäsi, joka luotiin rakentajan käynnistyksen yhteydessä. Lähdetiedoston otsikko kohdassa _supply.
Jos teet tämän tyyppisistä tiedostoista löydettäviä kielillesi tarkoitetuilla locale_dirs-asetuksilla, Sphinx löytää ne välittömästi. Sphinx poimii ne kutsumalla sphinx-make -M gettext -komentoa. He naiivisti kartoittavat viestejä ohjelmassa muunnettuun sarjaan. Sphinx käyttää tällaisia laitoksia muuttaakseen kokonaisia tiedostoja. Sphinxin luomien tekstien, kuten navigointitapojen, käännösten mukaisesti Sphinx tarjoaa elementtejä, jotka auttavat asiakirjojen uusinta tulkintaa. Kokoelma, jota voit käyttää uusimpien asiakirjojen etsimiseen.
Sarjallistamisen rakentajan tiedot¶
Voit aina käyttää omaa web-palvelintasi Sphinx HTML -tiedostojen palvelimiseen. Yksinkertainen tosiasia on, että tämä vaihtoehto tarjoaa paljon enemmän vapautta ja paljon enemmän monimutkaisuutta. Read the Docs on verkkopalvelu, joka keskittyy Sphinxillä kirjoitetun teknisen dokumentaation ja MkDocsin säilyttämiseen. Sphinx (pää)dokumenttien omistamiseen on olemassa Sphinx-käännössivusto.
