Sisältö
Upouusi koulutus on suunnattu Sphinx-aloittelijoille, jotka ovat valmiita oppimaan suunnitelmien tekemisen ja organisoinnin perusteet. Voit myös ladata kuvan omasta Git-repositoriostasi tar.gz- tai zip-tiedostomuotoon. Kun käytät Docker-kuvia, käytä Docker-työtilaa Sphinx-komentojen käynnistämiseen.
Ladattavien asiakirjojen viittaaminen¶
Uusi pääte kaikille normaaleille dokumenteille. Upouusi pickle creator on siitä loistava alaluokka. Sinun on määritettävä, mitkä tiedostot sisällytetään, ja siksi manuaaliset profiilit theman_users-asetuksen kautta ovat todella hyödyllisiä.
Kokonaisten API-lähdekoodien edistäminen¶
Sen luontityökalua käytetään uuden Sphinx/Docutils-kohderyhmän ”Audience for Transform to Blogger” -putken virheenkorjaukseen. onlinekasinolla.com vieraile sivustolla täällä Jokaista ylintä luokkaa olevaa tiedostoa tai alihakemistoa kohden luodaan yksi .cooking-kattilaluettelomalli. Sen luontityökalu luo gettext-tyyppisiä viestiluetteloita.
Tarkastele monien ulkoisten linkkien etiikkaa. Ohjaa käyttäjiä groff-tyyliin UNIX-järjestelmien omistamisessa. Mikä merkki on hyvä hakija omistamaan standard_part-tilan? Useiden tavoitteiden tapauksessa voit muuttaa "mikä tahansa" auttaaksesi sinua tietyssä osassa. Jos käytät sanaa, jota ei mainita sanastossa, saat varoituksen rakentamisen aikana. Linkitä määritettyyn tiedostoon; uusin tiedostotermi on perhe tai absoluuttinen polku, joka on tilannekohtainen, jopa ikkunalle.
Huomaa, että rinohtype tarjoaa ensisijaisen PDF-tiedostojen luontityökalun. Voit siis luoda laillisen ohjekirjan, jonka luontityökalu vaatii komentorivityökalun hiutil, joka on saatavilla vain Mac-käyttöjärjestelmälle X 10.6 ja uudemmille. Tällaiset kansiot on unohdettu kaikista muista dokumentaatiomalleista.
Uuden luojan tukemien MIME-tyyppisten kuvatyyppien luettelo. Visualisoi tietoja, kokeile hakea ostosta, missä ne näkyvät täällä. Jos haluat luoda linkkejä tietojen hakemiseen dokumentaatiostasi, voit tehdä sen sphinx.ext.intersphinx-komennolla. Python-koodia dokumentoitaessa on yleistä, että lähdetiedostoissa on paljon tietoja dokumentaatioketjussa. Se ei numeroi, joten tiedostossa on oikeat tiedostot forenumerate(); Sphinx hakee ne ja luo linkin niihin. Tämä merkintä luo linkin enumerate()-funktion uusimpiin tietueisiin.
Muiden mielenkiintoisten aktiviteettien ristiviittaukset¶
Pythonin lomakkeen enumerate() dokumentoimiseksi sinun tulisi sisällyttää se ainakin yhteen lähdetiedostoosi. Esimerkiksi kun katsot uutta HTML-tyyppiä, voit testata uutta lähdekoodia dokumentoinnissa – käytä sivupalkin "Kerro lähteestä" -linkkiä. Kuka tahansa voi luoda uuteen toctree-puuhun listaamiasi tiedostoja ja voit lisätä sisältöä, ja niiden osien otsikot syötetään (uudelle maxdepth-tasolle) siihen kohtaan, johon toctree-direktiivi on sijoitettu. Tarjottavat tiedostot annetaan tiedostotunnisteiden kautta, eli kirjaudut ulos tiedostopäätteestä ja harjoittelet kauttaviivojen (/) käyttöä hakemistoerottimina. Tämä on yksi Sphinxin reStructuredText-ominaisuuden osa, joka yhdistää useita tiedostoja yhteen tiedostojen tasoon.
Ennen kuin mainitsin, uusi conf.py-tiedosto säätelee, miten Sphinx käsittelee kirjoituksesi. Jokaiselle verkkotunnukselle on erityisiä sääntöjä sen mukaan, miltä uudet allekirjoitukset näyttävät ja miltä uusin muotoiltu toiminnallisuushaku näyttää. Jos et aseta erityisiä ominaisuuksia, kuten linkkejä parametrimerkkeihin, elizabeth.g. C/C++-verkkotunnuksissa. Uudessa direktiivissä on kyse kuvailemasi kohteen allekirjoituksesta, sisältö on tämän asiakirjan sisältö.
Että sen luoja tarjoaa samanlaisen tuotoksen kuin itsenäinen HTML-luontityökalu, mutta luo myös Qt-aputiedostojen kokoelman, joka mahdollistaa uusimman Qtcollection-generaattorin, jotta voit kerätä sen. Tämä rakentaja tarjoaa samanlaisen tuotoksen kuin itsenäinen HTML-luontityökalu, mutta luo myös HTML-aputiedostojen kokoelman, joka mahdollistaa uuden Microsoft HTML HelpWorkshopin, jotta voit kerätä sen hyvään CHM-tiedostoon. Tämä on tehokas HTML-rakentaja, joka yhdistää kaikki investoinnit tuotantotiedostoon. (Tietenkin se toimii vain lyhyempien aikataulujen kanssa.) Uusi tiedosto on nimetty kuten asetustiedosto.
Lisää rakentajia on saatavilla laajennuksilla. Nämä ovat Sphinx-rakentajien sisällä olevia. Joten sen mukavuusosa yrittää hallita sitä paremmin löytääkseen kelvollisen osoitteen viitetekstilleen. Sen ei yleensä tarvitse olla samassa asiakirjassa, koska termimerkinnöissä, mukaan lukien Python-dokumentit, on yksi kansainvälinen sanasto glossary.rst-tiedostossa. Erinomainen sanasto luodaan käyttämällä glossary-direktiiviä, jossa on luokitteluluettelo, jossa on ehtoja ja määritelmiä. Tämä luo yhteyden toiseen direktiiviin, jos sellainen löytyy.
Jotta intersphinxin käyttö olisi hauskaa, sinun on käynnistettävä se conf.py-tiedostossa lisäämällä uusi sekvenssi 'sphinx.ext.intersphinx' extensionslist-luetteloon ja lisäämällä se intersphinx_mapping-konfiguraatioarvoon. Uusin tiedosto yritetään suojata UTF-8-koodauksella automaattisesti, koska se näkyy encodingdeklaraatiossa ensimmäisessä osassa. Muista vain, että uusi tiedosto käyttää Python-syntaksia ketjulle, numerolle, listalle jne. Voit mukauttaa hyvän konfiguraation, joka ei ole automaattisesti uusi, luomalla vain uuden tehtävän sphinx-pikakäynnistyksen avulla. Uusi Python-sivuston nimi on vakioverkkotunnus, joten sinun ei tarvitse lisätä uusinta merkintää verkkotunnuksen etuliitteeksi. ReStructuredText tarjoaa laajemman johdanto-osan, jotta voit reStructuredTextin ja merkintöjä Sphinxin avulla.
