Avtomatizirani Roulettino aplikacija dokumenti starostne skupine stran od gesla

Podani so argumenti, ki osebno zasledujejo dvakratni anus, ki sledi izrazu direktive. Toctree je odlična direktiva reStructuredText, neverjetno prilagodljiv kos oznak. Napisal je odličen izvorni imenik, ki ima conf.py in lahko korensko datoteko list.rst.

Možnosti standardnih direktiv¶: Roulettino aplikacija

Odličen slovar, ki ima strani opredeljene vzdevke vrste, eno grafikonov ime vrste, ki vam pomaga pri polnem kvalificiranem imenu predmeta. Ki je vreden nadzora nad idejami o tem, kako prikazati tipske namige. To je resnično koristno, ko nekatere dodatne odvisnosti niso izpolnjene iz časa generiranja in razdelijo nov gradbeni proces.

Kam lahko postavite svoje lastne razširitve?¶

Številni podatki Sphinxa, kot so datoteke Python, so sestavljeni na spletnih mestih. Konfiguracija za zapise vseh ponujenih konfiguracijskih prepričanj. Popolnoma nova datoteka poskusite samodejno zaščititi znotraj UTF-8, kot je izraženo z deklaracijo kodiranja v Roulettino aplikacija prvem obsegu. Če želite prilagoditi resnično vredno konfiguracijo, ki je ne doda takoj sphinx-quickstart, vključite samo dodatni projekt. Prej sem trdil, da popolnoma nov dokument conf.py nadzoruje, kako Sphinx obdeluje vaše dokumente. Domene za vse lahko dostopne domene poleg njihovih direktiv/pozicij.

Prikažite nov podpis izraza kategorije. Če kategorija nima sredstev __init__ ali če je morda povsem nov niz dokumenta __init__ metode prazen, kljub temu razred vsebuje dokumentni niz __nove__ metode, se raje uporabi. Obe skupini in dokumentni niz metode __init__ sta dejansko povezani in registrirani. Vnesen je natančen dokumentni niz klasifikacije. Kar je vredno izbrati, kateri blogi bi bili združeni s temeljnim telesom iz direktive anautoclass. Najnovejša izvedba, odvisna od razreda dediščine, ne bo podpirala oblike vzdevkov PEP 695.

Izdano vsakič, ko se mora autodoc odločiti, ali bo član uporabljen v dokumentaciji. V primeru Real, najnovejši privzeti argument, ki razmišlja o funkcijah, morda ni bil pregledan pri ustvarjanju dokumenta. Čeprav ne, je to splošno uporabljen sestanek, da dobite novo blagovno znamko v svojo prvo vrstico iz niza dokumentov funkcije. Samodejno se postavi na vse direktive autodoc. To, da je res vredno, izbere, kako bo blagovna znamka prikazana vaši klasifikaciji, ki jo določa direktiva o samodejnem razredu.

Ponovna uporaba podpisov in lahko nizov dokumentov z autodoc¶

Vaš lahko še vedno dokumentira __init__, medtem ko druga strategija z uporabo samodejne metode in/ali udeležencev nadomesti samodejni razred. Zato lahko kombinirate samodejne in nesamodejne reprezentativne datoteke. Samodejno skuša autodoc pridobiti vrsto opombe in vrednosti najnovejšega, ki se razlikuje od introspekcije, kar dokazuje, da zasleduje oznako spremenljive. Da bi jo preglasili, lahko od argumenta uporabite prilagojeni niz vrednosti spremenljive, ki vam pomaga pri opombah. Ne ustvarjajte seznama vstopov v dokumentirano spremenljivo ali konstantno. Nato naredite vse možnosti, opisane pod privzetimi, uporabite slovar autodoc_default_options znotraj conf.py. Drugi jeziki so izvorno na voljo v Sphinxu za lastne namige, vodenje kodne dokumentacije, vendar potrebujejo razširitve za lastno samodejno kodno dokumentacijo, kot je Breathe.

Nastavitev¶

To se dolgoročno uporablja v jedru autodoc. Vredno je nadzorovati najnovejšo obliko tipskih namigov. Vzdevki za razvrščanje so ponujeni samo v primeru, da vaš sistem omogoča odloženo ocenjevanje iz elementa opomb (PEP 563) skozi __prihodnje__ pomembne opombe.

Conda paket¶

Katera razširitev prav tako uvozi popolnoma nove segmente, ki jih dokumentirate, in lahko predložite papirologijo nizov dokumentov na polavtomatiziran način. V katerem izvornem direktoriju je izvorni indeks, in izhodni direktorij boste poskusili v imeniku, kjer bi morali postaviti odvisne datoteke. Sveža možnost -Meters izbere ustvarjalca; v tem primeru Sphinx pogosto ustvarja podatkovne datoteke HTML. Sphinx ima tudi več dodatkov. Na primer, vsebuje vire med dokumenti v dlančniku (in deluje za vse izhodne različice) z uporabo ref. Znak skupaj s pomočjo besedilnega sporočila po meri priklopi na splošno stavčno strukturo med spletnimi mesti.