Vastalauseet annetaan henkilökohtaisesti kahdesti peräaukon jälkeen direktiivin identiteetin jälkeen. Toctree kokeilee erinomaista reStructuredText-direktiiviä, erittäin monipuolista merkintätapaa. Se on luonut lähdehakemiston, jossa on conf.py ja päätiedosto list.rst.

Luettelo parhaista nettikasinoista | Oletusdirektiivin mahdollisuudet¶

Loistava sanakirja, jossa on profiileja ja aliaksia, joiden avulla voi yhdistää lomaketunnisteen täysin pätevän kohdetunnisteen löytämiseksi. Se on hyödyllistä, kun jotkin lisäriippuvuudet täyttyvät usein rakennusvaiheessa ja uuden rakennusprosessin aikana.

Minne sijoitat omat laajennuksesi?¶

Useista Sphinx-tiedostoista, mukaan lukien Python-tietueet, on julkaistu sivustoilla. Configuration-tiedostot kaikille saatavilla oleville konfiguraatioarvoille. Uusi tiedosto tallennetaan automaattisesti UTF-8-muotoon, koska koodausdeklaraatio osoittaa ensimmäisen alueen. Jos haluat mukauttaa hyvän konfiguraation, joka ei ole suoraan lisättävää Sphinx-quickstartilla, luo vain uusi projekti. Ennen kuin sanoin, että uusi conf.py-tiedosto ohjaa sitä, miten Sphinx käsittelee viestisi. Domains-tiedostot kaikille saatavilla oleville domaineille sekä niiden direktiiveille/asetuksille.

Näytä luokan identiteetin uusin allekirjoitus. luettelo parhaista nettikasinoista Jos kategorialla ei ole __init__-metodia tai jos uusimman __init__-metodin dokumenttimerkkijono on tyhjä, mutta luokituksella on __new__-metodin dokumenttimerkkijono, sitä käytetään vuorotellen. Sekä kategoria että __init__-metodin dokumenttimerkkijono yritetään ketjuttaa ja rekisteröidä. Vain luokan dokumenttimerkkijono yritetään rekisteröidä. On syytä valita, mitkä viestit liitettiin autoclass-direktiivin pääjärjestelmään. Uusin historiaan perustuva luokittelu ei tue PEP 695 -tyyppisiä aliaksia.

Lähetetään aina, kun Autodocin on päätettävä, sisällytetäänkö jäsen dokumentaatioon. Jos oikein, funktioiden uusimpia vakioargumenttilausekkeita ei ehkä analysoida dokumentin luonnissa. Se on kuitenkin yleisesti käytetty käytäntö uuden tuotemerkin lisäämiseksi funktion dokumenttimerkkijonon ensimmäiselle riville. Se lisätään kaikkiin Autodoc-direktiiveihin automaattisesti. Tämä arvo valitsee, miten tuotemerkki näytetään Autoclass-direktiivin määrittämässä luokassa.

Allekirjoitusten ja dokumenttimerkkijonojen uudelleenkäyttö autodocissa¶

Voit edelleen dokumentoida __init__, koska toinen menetelmä käyttää automaattista menetelmää ja/tai käyttäjän valintaa automaattiseen luokitteluun. Voit siis yhdistää automaattisen ja matala-automaattisen liittämisen tiedostoihin. Oletusarvoisesti autodoc yrittää saada muuttuvan muuttujan merkinnän muodon ja arvon introspektiivisesti, mikä osoittaa, että ne seuraavat muuttujan nimeä. Tämän ohittamiseksi muuttujan arvoon voidaan kirjoittaa mukautettu merkkijono, koska ristiriita annotoidaan. Älä tee kokoelmamerkintää raportoidulle muuttujalle, muuten vakiona. Ja tee standardin alla näkyvät asetukset käyttämällä autodoc_default_options-sanakirjaa conf.py-tiedostossa. Muita kieliä tuetaan natiivisti Sphinxissä koodin dokumentointiin, mutta ne vaativat laajennuksia automaattiseen koodin dokumentointiin, kuten Inhal.

Asennus¶

Tätä hyödynnetään Autodoc Coressa tulevaisuudessa. Siksi on todellakin syytä säännellä uusinta typehints-tyyliä. Tyyppialiakset ovat käytettävissä vain, jos ohjelmasi sallii lykätyn merkintöjen arvioinnin (PEP 563) funktion __tulevien__ tärkeiden merkintöjen ulkopuolella.

Conda-paketti¶

Sen laajennus tuo myös uusimmat dokumentoimasi segmentit ja voit luoda tiedostoja dokumenttimerkkijonoista puoliautomaattisesti. Lähdehakemisto on lähdehakemisto ja tulostehakemisto on hakemisto, johon haluat sijoittaa alkuperäiset tiedostot. Uusi -Yards-vaihtoehto valitsee luojan; exampleSphinx luo usein HTML-tiedostoja. Sphinx tarjoaa myös useita muita lisäominaisuuksia. Voit esimerkiksi lisätä sekadokumenttiviittauksia kevyillä tavoilla (ja tämä toimii kaikilla tulostetyypeillä) käyttämällä ref-merkkiä. Se toimii myös mukautetun koukkutekstin tukena yleisessä sivustojenvälisessä lauserakenteessa.