Tämä luo HTML-dokumentit valitsemaasi create-hakemistoon. Nämä voidaan tehdä ajamalla create oman rakentajasi funktiolla. Sphinxin alkuperäistiedostoissa sinun tulisi käyttää standardreStructuredTextin ominaisuuksia.
- Sphinxdoc/sphinx-latexpdf sisältää TeXLive-paketteja.
- Älä käytä __all__-elementtiä analysoidessasi uutta dokumentoitavaa moduulia.
- Että uuden docstringin genetiikkaa kannattaa todella kontrolloida. Jos arvoksi asetetaan True, uudella docstringillä on luokkia, muuten vinkit, ellet nimenomaisesti määritä, periytyvät äideiltä.
- Se lähetetään vain, kun uusi reveal-inheritance-vaihtoehto on annettu.
I24Slot affiliate login | Asennus¶
Luodaan, kun Autodoc-ominaisuudet toteutuvat ja voit käsitellä hyvän dokumenttijonon. Tämä kannattaa säätää uusien dokumenttijonojen periytyvyyttä. Jos uusimman dokumenttijonon korjaamiseen tarkoitettu joukko sisältää luokkia, muuten prosesseja tai jopa nimenomaisesti paikkaa, se siirretään pois vanhemmilta. Se tuntee aliasien säilytysmuodon, jota ei ehkä arvioida tiedostossa. Ylikuormitettujen funktioiden tai prosessorien kuvauksessa ei ole tyyppivihjeitä, koska on epäkäytännöllistä näyttää kaikkia mahdollisia ylikuormituksia oikein, koska hyvä tietokanta on olemassa.
Satamatyöläinen¶
Sphinxin erinomaisen, ainutlaatuisen perustekstitiedoston lähdekoodin juuriluetteloa kutsutaan syyluetteloksi. Kun olet tässäkin valmis, i24Slot affiliate login voit tutustua asennusoppaaseen ja sen jälkeen uuteen johdantoon Sphinxin käyttämästä oletusmerkintärakenteesta, reStructuredTextistä. Tämän dokumentin tarkoituksena on antaa sinulle nopea käsitys siitä, mitä Sphinx on ja miten sitä käytetään.
- Löydät lukuisia sphinx-contribororganisaation käyttäjien jakamia laajennuksia.
- Luo automatisoituja asiakirjoja tavoiteluokituksen yksilöllisille jäsenille, jotka tunnetaan myös nimellä "dunder"-tunnisteet. Mukana ovat myös tuotemerkit, joissa on kaksi taitettua alaviivaa, elizabeth.grams.
- Ja luo erinomaisen linkin tuoreeseen vastaavaan envvar-direktiiviin, jos sellainen löytyy.
Ristiviittaukset kohteihin¶
Tarjottu uusi tiedostonimi on usein uuden hakemiston mukainen, jossa nykyinen lähdetiedosto todellisuudessa sijaitsee, mutta jos ne ovat absoluuttisia (aloitat /-merkillä), se otetaan ensisijaisen resurssihakemiston mukaan. Linkki haluttuun tiedostoon; uusi tiedostonimi on perheen tai absoluuttisen polun jäsen, ja se on aina tapauskohtainen ja tuskallinen, jopa näytölle. Se annetaan sillä ehdolla, että uusi perimätietovaihtoehto on tarjolla. Perusteet on yhteenveto luokista, joilla on käsittelijä, joka voi muokata sitä, mitä Sphinx lisää tulosteeseen. Kun nollarivi täsmää, uusin seuraava dokumenttimerkkijono on tyhjä, joten muutoksia ei tehdä, ellei keepempty-asetus ole tosi.
Verkkotunnus on itse asiassa pari siihen kuuluvaa objektityyppiä, jotka on yksityiskohtaisesti kuvattu merkinnöillä, jotka auttavat luomaan ja viittaamaan näiden asioiden kuvauksiin. Sphinxin perustavoitteena on selkeät tiedot asioista (yleisessä merkityksessä) missä tahansa verkkotunnuksessa. Mutta ei, Sphinx-pikakäynnistysohjelmisto sisältää Makefile-tiedoston ja voit käyttää amake.bat-tiedostoa, mikä tekee elämästäsi helpompaa.
Ääriviivat ovat ketjuluettelo – käsitellyn dokumenttijonon uudet rivit – kokemusten käsittelijä voi mukauttaa sen, mitä Sphinx jättää suoritukseksi. Tämä voidaan poistaa käytöstä, jos koodisi ei leiki tyyppilausekkeilla, kuten käyttääkö se vain merkintöjen muotoja vai ei leiki minkäänlaisten vihjeiden kanssa. Kommentit syöttävät koodia täydentämään tuhottuja merkintöjen muotoja, kun se on oikein.
Vältä __all__-merkin käyttöä analysoidessasi uusinta komponenttia dokumentointia varten. Vaihtoehtoisesti Autodoc voi myös tunnistaa docstring-merkkijonon uudella alueella, kun tämä on tehty. Jos tarvitset NumPy:tä tai Google suunnittelee docstring-merkkijonoja enemmän reStructuredText-muodossa, voit ottaa käyttöön Napoleon-laajennuksen. Napoleon on erinomainen esikäsittelijä, joka muuntaa docstring-merkkijonot oikeaksi reStructuredText-muotoon ennen kuin Autodoc käsittelee ne. Käytät fiktiivistä ohjelmistokirjastoa satunnaisten syöntimerkkijonojen luomiseen, mikä auttaa prosessin läpiviennissä, jotta ne voidaan dokumentoida turvallisesti. Yleensä suunnitelma tunnetaan nimellä python3-sphinx, python-sphinx tai sphinx. Katso lisätietoja Sphinx-build-verkkosivulta.