Onko tietueet erillään Bao kasinopeli docstrings-merkinnöistä?

Tämä rakentaa HTML-dokumentit valitsemaasi rakennushakemistoon. Nämä voidaan tehdä Bao kasinopeli ajamalla generate rakentajasi ehdolle. Sphinx-alkuperätiedoissa sinun tulisi käyttää useimpia standardreStructuredTextin ominaisuuksia.

• Sphinxdoc/sphinx-latexpdf sisältää TeXLive-paketteja.
• Vältä __all__-metodin käyttöä analysoidessasi uusinta moduulia, jotta voit dokumentoida sen.
• Mikä todella arvoinen hallitsee uusien docstringien genetiikkaa. Jos asetus on Aito, uusin docstring omistaa lajeja, muuten toiminnot, jos et nimenomaisesti aseta, periytyvät äideiltä.
• Se myönnetään sillä ehdolla, että uusin perintöilmoitusvaihtoehto on tarjolla.

Bao kasinopeli – Asennus¶

Lähetetään, kun autodoc tarjoaa toteutusta ja voit käsitellä hyvän dokumenttijonon. Se, että se hallitsee uusien dokumenttijonojen periytyvyyttä. Kun asetettu korjaamaan uusi dokumenttijono ryhmien tai vaiheiden osalta, jos ne eivät ole selvästi sijoitettuja, ne siirretään pois äideiltä. On tuttua, että säilytystyyppisiä aliaksia ei ehkä arvioida asiakirjassa. Ylikuormitettujen ominaisuuksien tai toimintojen kuvauksessa ei käytetä tyyppivihjeitä, koska on mahdotonta esittää kaikkia mahdollisia ylikuormituksia oikein täydellisenä tietoluettelona.

Satamatyöläinen¶

Sphinxin tavallisen tekstitiedoston lähdekoodin perushakemistoa kutsutaan päähakemistoksi. Kun olet valmis, voit tutustua asennusoppaaseen ja uuteen johdantoon, joka auttaa sinua Sphinxin käyttämän oletusmerkintätyylin, reStructuredTextin, kanssa. Tämän dokumentin tarkoituksena on antaa sinulle nopea yleiskuva siitä, mikä Sphinx on ja miten sitä käytetään.

• Löydät useita profiilien tarjoamia laajennuksia sphinx-contriboorganization-sivustolta.
• Tee automaattisesti tietueita potentiaalisen ryhmän erityishenkilöistä, jotka on merkitty "dunder"-brändeiksi. Tämä sisältää kaikki brändit, joilla on kaksoispainotus, ikä.grams.
• Yhdessä luo loistavan linkin uuteen vastaavaan envvar-direktiiviin, kun se löytyy.

Ristiviittaukset¶

Uusi harkitseva tiedostonimi voi olla nykyisen lähdetiedoston uuden indeksin mukainen, mutta jos ne ovat puhtaita (alkaen /-merkillä), se otetaan resurssiluettelon yläosan mukaan. Suhde haluttuun tiedostoon; uusin tiedostonimi on perheenjäsen tai absoluuttinen polku, joka on aina instanssiherkkä, myös Windowsille. Se lähetetään vain, jos uusi reveal-genetics-vaihtoehto harkitsee. Perusteet on yhteenveto luokista, joita datakäsittelijäsi voi muokata parantaakseen sitä, mitä Sphinx jättää tuotannolle. Jos rivit eivät täsmää, uusi seuraava dokumenttimerkkijono voi olla tyhjä, eikä muutoksia tehdä, ellei keepempty-arvoa ole voimassa.

Verkkotunnus kokeilee joukkoa siihen kuuluvia objektityyppejä, jotka sisältävät luotavan merkinnän ja joihin voit viitata näiden kohteiden kuvauksilla. Yksi Sphinxin päävaatimuksista on asioiden yksinkertainen dokumentointi (aina perusmuodossaan) millä tahansa verkkotunnuksella. Mutta ei, Sphinx-pikakäynnistystyökalu sisältää Makefile-tiedoston ja voit käyttää amake.bat-tiedostoa, mikä tekee elämästä helpompaa.

Contours on itse asiassa hyvä lista merkkijonoista – käsitellyn dokumenttijonon uusista jäljistä – joita käsittelijä voi mukauttaa määrittääkseen, mitä Sphinx lisää suorituskykyyn. Tämä on haitallista, jos alkuperäinen salasanasi ei tutki tyyppikommentteja, esimerkiksi sitä, käyttääkö se kokonaan merkintöjen muotoa vai eikö se leiki minkäänlaisten vinkkien kanssa. Syöttökoodin lauseet korvaavat unohtuneet tyyppimerkinnät, jos se on oikein.

Älä käytä __all__-muuttujaa analysoidessasi uusinta moduulia tiedostoa varten. Sen sijaan autodoc voi ymmärtää erinomaisen docstring-lauseen uudella rivillä merkityksen jälkeen. Jos haluat NumPyn tai Googlen käyttävän docstring-lauseita reStructuredTextin sijaan, voit sallia napoleon-laajennuksen. napoleon on hyvä esikäsittelijä, jolla voit muuntaa docstring-lauseet oikeine reStructuredText-lausekkeineen ennen kuin autodoc käsittelee ne. Tulet hallitsemaan loistavaa fiktiivistä ohjelmistopakettia mielivaltaisten ruokailutoimintojen luomiseksi, jotka toimivat hyvänä oppaana koko prosessin ajan ja joiden tarkoituksena on dokumentoida se turvallisesti. Yleensä pakettia kutsutaan nimellä python3-sphinx, python-sphinx tai sphinx. Katso lisätietoja sphinx-make-lisäsivulta.