Sfinkso dokumentų turinio lielākais bez depozīta RoyalGame medžiaga

„autosummary“ sukurtas santraukos tinklalapis¶ Ir vėl galite, paleidus „make html“, naujausias našumas gali būti toks pat kaip ir anksčiau. Ankstesnėje pamokos dalyje rankiniu būdu dokumentavote Python nustatymus „Sphinx“ viduje. Tačiau ne, conf.py taip pat gali būti gyvas kitame sąraše, naujausių nustatymų kataloge. Sphinx.ext.intersphinx dėl visiško populiarių „intersphinx“ funkcijų gedimo.

Naujo generavimo paleidimas¶ – lielākais bez depozīta RoyalGame

„Toctree“ yra puiki „reStructuredText“ direktyva – labai lanksti žymėjimo dalis. Kai baigsite, galite peržiūrėti diegimo knygą su nauja įžanga, kuri padės jums suprasti numatytąjį „Sphinx“ naudojamą žymėjimo formatą „reStructuredText“. Kitos kalbos bando būti pateikiamos „Sphinx“ viduje rankiniam kodo dokumentavimui, tačiau joms reikalingi plėtiniai automatiniam kodo dokumentavimui, įskaitant „Breathe“. Norėdami programuoti „Sphinx“ funkcijas kodo dokumentams valdyti, planuojate naudoti „Python“, kuris taip pat palaiko automatinį kodo dokumentavimą. Turėsite sukurti puikią išgalvotą programinės įrangos rinkinį, kad sukurtumėte atsitiktinius valgymo metodus, kurie padės vadovautis procesu, siekiant juos saugiai įrašyti. Projekte turėtų būti pasakojimas, ranka rašyti dokumentai ir automatiškai sugeneruoti API įrašai.

Kryžminės nuorodos į kitus įdomius elementus¶

Informacijos apie naują efektyvumo struktūrą ieškokite serializacijos kūrimo priemonėje. Kuri kūrimo priemonė naudoja modulį, kad paleistų naująją „Python“ serializacijos API (pvz., „pickle“, „simplejson“, „phpserialize“), kad galėtumėte atsikratyti sugeneruotų HTML dokumentų. Turite nurodyti, kurie failai bus įtraukti į „Texinfo“ dokumentus per „texinfo_documentsconfiguration“ reikšmę. Kad kūrimo priemonė teikia „Texinfo“ dokumentus, kuriuos „makeinfo“ sistema gali apdoroti jūsų duomenų failais. Kad kūrimo priemonė teikia panašią išvestį kaip ir atskira HTML kūrimo priemonė, taip pat sukuria entuziastingą epub versiją el. knygų klientams.

Kiekviena direktyva nustato, kada ir kiek ji turi lielākais bez depozīta RoyalGame prieštaravimų. Argumentai pateikiami atskirai po dvigubo dvitaškio, einančio po direktyvos pavadinimo. Pagrindinė pagrindinio failo paskirtis – būti puikiu pasisveikinimo puslapiu ir palaikyti „darbalaukio iš turinio miško“ (kitaip – ​​„toctree“) šaknį. „soit“ failo paskirtis – padėti jums greitai suprasti, kas iš tikrųjų yra „Sphinx“ ir kaip jį naudoti.

Svetainė iš tikrųjų yra pora objektų tipų, kurie priklauso vienas kitam, išsamiai aprašyti su žymėjimu, kuris padeda sukurti, ir galite remtis šių elementų aprašymais. „Build latexpdf“ paleidžia naujausią „Latex“ kūrimo priemonę, kuri patogiai iškvies naują „pdfTeXtoolchain“. Tačiau „sphinx-quickstart“ programa sukuria puikų „Makefile“ failą, o jūs galite naudoti „amake.bat“, kuris palengvina gyvenimą.

Tai gali sugeneruoti HTML dokumentus jūsų pasirinktame kūrimo kataloge. Tai galima padaryti paleidus komandą „make“ kūrėjo terminui. (Jie gali apimti ir „toctree“ direktyvas, kad prireikus galėtumėte sukurti rimtai įdėtas hierarchijas.)

Pirmasis susitarimas¶

Kiekviena direktyva nustato, ar leisti jai būti įrašams, ir kokia kryptimi judėti. Turinys pateikiamas po jūsų parinkčių, kitaip argumentai yra tuščias diapazonas. „Maxdepth“ yra tokia alternatyva „toctree“ direktyvoje.

Kuriame indekse taip pat yra naujas „Sphinx“ konfigūracijos failas conf.py, kuriame galite tvarkyti visus „Sphinx“ šaltinio tikrinimo aspektus ir sukurti failus. Tačiau nauji „reStructuredText“ šaltinio failai yra naujame „_supply“ indekse, esančiame produktyvumo kataloge. Taigi, kūrimo priemonė sukuria knygos failą kiekvienam „reStructuredText“ failui. Tai beveik identiška naujajam „reStructuredText“ šaltiniui, tačiau dauguma naujausių žymėjimų yra pašalinti, kad būtų lengviau skaityti. Norėdami pamatyti galimas parinktis, raskite „latex_documents“ ir skyrių „Options for Exudate output“.

Taigi, kūrimo priemonė sukuria panašią išvestį kaip ir atskira HTML kūrimo priemonė, bet taip pat sukuria GNOME kūrėjo palaikymo failą, kuris leidžia naujausiai GNOME kūrėjo skaitytuvei gauti prieigą prie jų. Pavyzdžiui, naujausias documentmarkup/rest.rst negali sukelti produktyvumo documentmarkup/other.html failo, tačiau markup/rest/index.html. Jų produktyvumas yra didelis katalogas su HTML duomenų failais, kuriame kiekvienas dokumentas vadinamas directory.html, o jūs būsite išvardyti kaip pakatalogis, pavadintas tokiu pačiu pavadinimu kaip jų tinklalapio pavadinimas. Naujo kūrimo priemonės „pavadinimas“ turi būti prieinamas naujam -Yards, kitaip -b paklausos-range parinktys iš sphinx-generate, kad pasirinktų kūrėją.