Tämä luo HTML-dokumentteja valitsemastasi luontihakemistosta. Nämä voidaan suorittaa suorittamalla rakentaminen rakentajan toimikaudellesi. Sphinx-resurssitiedostojen sisällä voit käyttää standardreStructuredTextin todella suosittuja ominaisuuksia.

• Sphinxdoc/sphinx-latexpdf sisältää TeXLive-paketteja.
• Älä käytä __all__ aina kun tutkit uutta komponenttia dokumentoinnin helpottamiseksi.
• Joten se arvo ohjaa upouusi dokumenttijonojen periytymistä. Jos asetus on Korjaa uusi dokumenttimerkkijono ryhmille, muuten vinkkejä tai jopa selkeä paikka, siirtyy äideiltä.
• Sitä pidetään niin kauan kuin uusin paljastamisperinnöllisyysvalinta harkitsee.

Asetukset¶ – Tämä postaus

Tuotetaan, kun autodoc on ymmärtänyt ja voit valmistaa hyvän dokumenttisarjan. Että se todella kannattaa säädellä uusia docstrings perinnöllisyys.Jos asetettu Aito tuore docstring hallussaan luokkia tai vaiheita, tai jopa selkeästi paikka, on todella peritty äideiltä ja isiä. Se on aina säilytettävä aliaksien muoto, jota ei ehkä ole arvioitu asiakirjassa. Ylikuormitetuissa ominaisuuksissa tai vaiheissa ei käytetä kirjoitusvihjeitä kuvauksessa, koska on epäkäytännöllistä esittää oikein kaikkia mahdollisia ylikuormituksia erinomaisena parametriluettelona.

Docker¶

Sfinksille ominaisen perustekstiviestitiedostotarjouksen juuriluetteloa kutsutaan pääsyyluetteloksi. Kun olet valmis, voit siirtyä asennusoppaaseen ja uusimpaan esittelyyn Tämä postaus , joka auttaa sinua Sphinxin käyttämän oletusmerkintätyylin, reStructuredTextin, kanssa. Minkä tiedoston tavoitteena on antaa sinulle yksinkertainen valinta siitä, mitä sfinksit ovat ja miten voit käyttää niitä.

• Sphinx-contriborganizationin profiileista on jaettu useita laajennuksia.
• Luo automaattisia tietueita, jotta sinulla on ainutlaatuiset merkkiluokituksen jäsenet, joita kutsutaan «dunder»-brändeiksi. Tämä sisältää kaikki mukana olevat tuotemerkit, joissa on kaksinkertainen alaviiva elizabeth.grams.
• Se myös luo loistavan linkin upouuteen ilmaiseen envvar-direktiiviin, jos tämä löytyy.

kohteiden ristiinviittaukset¶

Uusi harkittava tiedostonimi on usein suhteessa tuoreeseen luetteloon, josta nykyiset lähdetiedostot löytyvät, mutta jos se on puhdas (aloitat /), se otetaan päälähdehakemiston mukaisesti. Suhde haluttuun tiedostoon; upouusi tiedostotunniste tulee olemaan lähisukulainen tai absoluuttinen polku, joka voi yleensä olla instanssi-kivulias ja herkkä itse asiassa Windowsille. Se lähetetään vain, kun uusin kerro-perintövaihtoehto on annettu. Pohjat ovat yhteenveto sellaisista tyypeistä, joita tuntumankäsittelijä voi muokata paikoilleen muuttaakseen tarkalleen mitä Sphinx sijoittaa tuotantoa varten. Jos linjasaumaa ei ole, uusi seuraava dokumenttimerkkijono voi mahdollisesti olla tyhjä, joten nolla alter voidaan mahdollisesti tehdä, ellei keepempty ole totta.

Sivusto on itse asiassa joitain objektityyppejä, jotka kuuluvat yhteen, yksityiskohtaisesti tuotetuilla merkinnöillä, ja voit viitata näiden asioiden kuvauksiin. Yksi Sphinxin tärkeimmistä odotuksista ei ole vaikeita tietueita esineistä (keskimäärin normaalin kokemuksen sisällä) millään alalla. Sphinx-quickstart-ohjelma luo kuitenkin Makefile-tiedoston ja amake.bat-tiedoston, joka tekee käyttöiän helpommaksi.

Traces on itse asiassa erinomainen luettelo jousista – puristetun dokumenttijonon upouudet linjat – nautintokäsittelijä, joka on räätälöity muuttamaan mitä Sphinx jättää tuotantoon. Tämä ei ole käytössä, jos lähdesalasanasi ei pidä hauskaa erityyppisten lausuntojen kanssa, esimerkiksi käyttääkö se vain merkintöjen muodossa tai ei pidä hauskaa minkäänlaisten ehdotusten kanssa. Kommentit pois lähdekoodista täydentämään tuhoutuneita huomautuksia, kun aito.

Älä käytä __all__ aina, kun analysoit uutta dokumentoitavaa komponenttia. Vaihtoehtona autodoc tunnistaa hyvän dokumentin uudella rivillä tämän jälkeen. Jos haluat NumPyn muutoin Google-tyylisiä dokumenttimerkkijonoja reStructuredTextin sijaan, voit myös ottaa käyttöön napoleon-laajennuksen. Napoleon on loistava esiprosessori, joka muuntaa dokumenttimerkkijonot oikeaksi uudelleenrakennetekstiksi ennen kuin Autodoc käsittelee ne. Aiot luoda erinomaisen fiktiivisen ohjelmistokokoelman tuottaaksesi satunnaisia ​​syömishoitoja, jotka auttavat opastamaan koko menetelmän ajan, jotta ne voidaan dokumentoida turvallisesti. Yleensä suunnitelmaa kutsutaan nimellä python3-sfinksi, python-sfinksi tai muuten sfinksi. Lisätietoja on thesphinx-create son -sivulla.