Vastalauseet annetaan henkilökohtaisesti noudattamalla direktiivin nimeä seuraavaa kaksinkertaista peräaukkoa. Toctree on loistava reStructuredText-direktiivi, erittäin joustava merkintätapa. Se muodosti lähdehakemiston conf.py-tiedostolla ja voit luoda juurihakemiston index.rst-tiedostona.
Hejgo kirjautuminen: Standardidirektiivin vaihtoehdot¶
Hyvä sanakirja, jossa Hejgo kirjautuminen käsitellään profiileja ja aliaksia, joiden avulla lomaketunniste voidaan yhdistää täysin lisensoituun objektitunnisteeseen. Siksi on syytä säätää ideoita tyypin vihjeiden esittämiseen. Tämä on hyödyllistä, kun jotkin ulkoiset riippuvuudet, jotka yleensä täyttyvät luontivaiheessa ja jakavat uuden rakennusprosessin.
Minne voit laittaa omat laajennuksesi?¶
Lukuisista Sphinx-datatiedostoista, kuten Python-dokumentaatio, on koottu verkkosivustoille. Kokoonpano kaikille saatavilla oleville konfiguraatiofilosofian asiakirjoille. Uusin tiedosto tallennetaan oletusarvoisesti UTF-8-muodossa, kun taas ensimmäisellä rivillä oleva koodausilmoitus osoittaa sen. Voit mukauttaa hyvän konfiguraation, joka ei ole heti lisättävää Sphinx-pikakäynnistyksen avulla, luo vain uusi projekti. Ennen kuin mainitsin, uusi conf.py-tiedosto ohjaa sitä, miten Sphinx käsittelee kirjoituksesi. Verkkotunnukset kaikille saatavilla oleville verkkotunnuksille ja niiden direktiiveille/tehtäville.
Näytä uusi allekirjoitus luokan otsikossa. Jos kategoriallasi ei ole __init__-metodia tai jos uuden __init__-metodin dokumenttimerkkijono on tyhjä, mutta kategorialla on __new__-metodin dokumenttimerkkijono, sitä käytetään sen sijaan. Luokan ja __init__-metodin dokumenttimerkkijonot yhdistetään ja syötetään. Ryhmän dokumenttimerkkijono lisätään. Tämä arvo valitsee, mikä sisältö liitetään autoclass-direktiivin perusjärjestelmään. Uusin vanha kategoriakohtainen suoritus ei tue PEP 695 -alias-muotoa.
Lähetetään, kun Autodocin on valittava, käytetäänkö kumppania dokumentaatiossa. Jos arvo on True, ominaisuuksien uusinta oletusarvoista argumenttifilosofiaa ei ehkä analysoida tiedostoa luotaessa. Mutta ei, se on yleisesti käytetty kurssi, jolla uusi tuotemerkki saadaan ensimmäiselle riville funktion dokumenttijonosta. Sitä voidaan soveltaa automaattisesti kaikkiin Autodoc-direktiiveihin. Tämä arvo valitsee tavan, jolla tuotemerkki näytetään Autoclass-direktiivin määrittämässä luokassa.
Allekirjoitusten kierrätys ja saatat dokumentoida merkkijonoja, joissa on autodoc¶
Voit silti tiedostoa __init__ käyttää vaihtoehtoisena menetelmänä käyttämällä automaattista menetelmää tai korvaamalla autoclassin. Siksi voit myös sekoittaa automatisoituja ja vähän automatisoituja liitännäistietueita. Autodoc yrittää automaattisesti määrittää muuttuvan muuttujan merkinnän tyypin ja arvon introspektion perusteella, mikä osoittaa, että ne seuraavat muuttujan nimeä. Voit ohittaa sen käyttämällä mukautettua merkkijonoa muuttujan arvossa annotaation luomiseksi. Älä luo hakemistomerkintää raportoituun muuttujaan tai säilytä sitä. Jos haluat tehdä joistakin alla olevista vaihtoehdoista oletusarvoja, käytä autodoc_default_alternatives-sanakirjaa conf.py-tiedostossa. Muita kieliä tuetaan natiivisti Sphinxin ohjekoodidokumentaatiossa, mutta ne vaativat laajennuksia automaattiseen koodidokumentaatioon, kuten Inhal.
Asennus¶
Tämä on integroitu autodoc-ytimeen pitkällä aikavälillä. Joten typehints-tyyppisten vihjeiden uusimman rakenteen hallinta on todellakin vaivan arvoista. Lajittelualiaksia tarjotaan vain, jos järjestelmäsi sallii lykätyn arvioinnin merkintöjen ulkopuolella (PEP 563) -ominaisuuden __tulevien__ tärkeiden merkintöjen kautta.
Conda-paketti¶
Laajennus tuo myös dokumentoimasi uudet moduulit ja luot tiedostoja dokumenttijonoista puoliautomaattisella tavalla. Missä sourcedir on alkuperäishakemisto ja outputdir on hakemisto, johon haluat sijoittaa pohjana olevat tiedot. Uusi -Meters-vaihtoehto valitsee rakentajan; esimerkiksi Sphinxillä on tapana luoda HTML-tietoja. Sphinx on lisännyt useita muita. Voit esimerkiksi lisätä dokumenttien välisiä suosituksia kevyisiin tapoihin (ja siten toimii kaikille tulostetyypeille) ref-osan avulla. Se tukee myös mukautettuja koukkuviestejä yleisessä lähdekoodien välisessä lauserakenteessa.