Argumentit annetaan Gonzos Quest 150 ilmaiskierrosarvostelua henkilökohtaisesti kahden kaksoispisteen jälkeen direktiivin nimen perässä. Toctree on itse asiassa hyvä reStructuredText-direktiivi, erittäin monipuolinen merkintätyökalu. Se kirjoitti hyvän lähdekoodihakemiston conf.py-tiedostolla ja saat root-dokumentin nimeltä list.rst.
Gonzos Quest 150 ilmaiskierrosarvostelua: Standardidirektiivin vaihtoehdot¶
Hyvä sanakirja omille sivuilleen määrittelee aliaksia, joiden avulla voit luoda lomakkeen nimen täysin pätevän kohdeotsikon mukaan. Joten arvo-ohjausobjektien vihjeet kuvaavat tyyppivihjeitä. Tästä on hyötyä, kun jotkin ulkoiset riippuvuudet eivät täyty luontihetkellä ja rikkovat uuden rakennusprosessin.
Minne yksittäiset laajennuksesi sijoitetaan?¶
Useista Sphinx-tiedoista, esimerkiksi Python-tiedostot, on itse asiassa kirjoitettu verkkosivustoille. Kaikkien saatavilla olevien määritysarvojen dokumentointia varten konfigurointi. Uusi tiedosto yritetään suojata UTF-8-muodossa automaattisesti, kuten ensimmäisellä rivillä olevasta koodausilmoituksesta välitetään. Jos haluat mukauttaa hyvän määritysarvon, jota ei automaattisesti lisätä Sphinx-quickstart, lisää vain ylimääräinen tehtävä. Ennen kuin mainitsin, uusi conf.py-tiedosto ohjaa sitä, miten Sphinx käsittelee tiedostojasi. Verkkotunnukset kaikille saatavilla oleville verkkotunnuksille ja niiden direktiiveille/asetuksille.
Näytä uusi tuotemerkki luokan otsikossa. Jos luokassasi ei ole __init__-metodia tai jos uusimman __init__-metodin dokumenttimerkkijono on tyhjä, mutta ryhmä tarjoaa __new__-metodin dokumenttimerkkijonon, se asetetaan sen sijaan. Sekä ryhmän että __init__-metodin dokumenttimerkkijonot yhdistetään. Vain luokan dokumenttimerkkijono rekisteröidään. Joten kannattaa valita, mitkä blogit rekisteröidään perustietokantaan autoclass-direktiivin sijaan. Uusin vanhaan luokitteluun perustuva toteutus ei tue PEP 695 -tyyppisiä aliaksia.
Julkaistu, kun Autodocin on valittava, käytetäänkö jäsentä dokumentaatiossa vai ei. Kun arvo on True, palveluiden uutta vakiomuotoista erimielisyyden ajattelua ei ehkä testattu tiedostoa luotaessa. Mutta ei, se on yleisesti käytetty käytäntö sijoittaa uusin allekirjoitus funktion dokumenttijonon ensimmäiselle riville. Se voidaan sijoittaa kaikkiin Autodoc-direktiiveihin automaattisesti. Arvo, joka valitsee allekirjoituksen, voidaan näyttää Autoclass-direktiivin määrittämässä luokassa.
Allekirjoitusten ja dokumenttimerkkijonojen uudelleenkäyttö autodocin avulla¶
Voit silti dokumentoida __init__ vaihtoehtoisena strategiana käyttämällä automaattista menetelmää tai korvaamalla autoclassin. Voit siis sekoittaa automatisoituja ja ei-automatisoituja liitännäisdokumentteja. Autodoc yrittää automaattisesti saada uusimman muuttujan tyypin ja arvon introspektiolla, näyttäen ne muuttujan otsikon jälkeen. Voit ohittaa tämän käyttämällä mukautettua merkkijonoa muuttujan arvolle, koska ristiriita annotaatiossa on. Älä luo luettelomerkintää mainitulle muuttujalle, muuten se on vakio. Tee sitten kaikki alla kuvatut asetukset oletusarvoisesti käyttämällä conf.py-tiedostossa olevaa autodoc_default_options-sanakirjaa. Sphinxissä on natiivisti muita kieliä koodidokumentaation luomiseen, mutta he haluavat laajennuksia, kuten Inhale, joilla on automatisoitu koodidokumentaatio.
Asennus¶
Tämä sisällytetään autodoc-ytimeen lähitulevaisuudessa. Joten typehints-tyylin säänteleminen on todellakin vaivan arvoista. Lajittelualiaksia tarjotaan vain, jos järjestelmäsi sallii lykätyn arvioinnin merkinnöistä (PEP 563) -ominaisuuden __tulevien__ tärkeiden merkintöjen kautta.
Conda-sopimus¶
Joten laajennus siirtää myös tallentamasi uudet segmentit, ja voit esittää tiedostoja docstrings-tiedostoista puoliautomaattisella tavalla. sourcedir on alkuperäishakemisto ja outputdir on hakemisto, johon haluat sijoittaa pohjana olevat asiakirjat. “-M“-vaihtoehto valitsee rakentajan; tässä esimerkissä Sphinx yleensä luo HTML-tiedostoja. On jopa monia muita, joilla on enemmän Sphinxin ansiosta. Esimerkiksi ne sisältävät tiedostojen välisiä suosituksia kevyellä tavalla (ja siksi toimivat kaikilla tuotantobrändeillä) ref-osan kanssa. Se toimii ja tukee mukautettua tekstiviestin yhdistämistä yleiseen resurssien väliseen lauserakenteeseen.