Artiklid
Lõppkokkuvõttes on autosummary loodud veebileht sissemakseta YoyoSpins mobiilne ¶ Ja jällegi, kohe pärast create html käivitamist on uusim jõudlus sama, mis eelmisel. Õpetuse varasemas osas dokumenteerisite käsitsi Pythoni vormi Sphinxis. Kuid mitte, conf.py saab ka reaalajas teises kataloogis uusima paigutuse loendi luua. Sphinx.ext.intersphinx sisaldab intersphinxi populaarsete funktsioonide täielikku kirjeldust.
Uusima versiooni käivitamine¶ – sissemakseta YoyoSpins mobiilne
Toctree on reStructuredText direktiiv, väga paindlik märgistusosa. Kui olete siin kohal, saate liikuda installijuhendi juurde, millele järgneb Sphinxi poolt kasutatava vaikemärgistusvormingu reStructuredText uus sissejuhatus. Teised keeled toetavad Sphinxi natiivselt koodi dokumenteerimise juhiseid, kuid vajavad automaatse koodi dokumenteerimise laiendusi, näiteks Breathe. Sphinxi potentsiaali programmeerimiseks koodifailide jaoks kasutate Pythoni, mis toetab ka automatiseeritud failide vanuserühma. Võib olla hea väljamõeldud tarkvarakomplekt juhuslike söögivalemite loomiseks, mis on kogu protsessi vältel heaks juhiseks, eesmärgiga neid turvaliselt dokumenteerida. Teie paneelid peaksid sisaldama narratiivset, käsitsi kirjutatud dokumentatsiooni ja automaatselt genereeritud API-faile.
Muude huvitavate asjade ristviitamine¶
Leidke serialiseerimise koostaja kohta fakte, et saada teavet uue tootlikkuse stiili kohta. Seega kulutab looja komponendi uue Pythoni serialiseerimise API (pickle, simplejson, phpserialize jne) käivitamiseks, et kustutada genereeritud HTML-failid. Peate kindlaks määrama, kas need andmed on olemas ja kas Texinfo andmefailid texinfo_documentsconfiguration kaudu on väärtuslikud. Milline looja pakub Texinfo andmefaile, mida makeinfo süsteem saab andmefailide jaoks salvestada? See looja pakub sarnast väljundit kui eraldiseisev HTML-looja, aga loob ka entusiastliku e-raamatu rakenduse e-raamatute lugejatele.
Iga direktiivi puhul otsustab ta, kas sellel võib olla vastuväiteid ja kui palju. Argumendid esitatakse isiklikult pärast kahekordset koolonit, mis järgneb direktiivi identiteedile. Dokumendi peamine eesmärk on toimida suurepärase tervituslehena ja olla sisupuu (või teemapuu) alumine osa. Dokumendi eesmärk on jätta teile kiire huvi selle vastu, mis on Sphinx ja kuidas seda kasutada.
Sait proovib paari temaga seotud objektitüüpi, mis sisaldab märgistust üksuste loomiseks ja kirjeldamiseks. Make latexpdf käivitab uue Exudate'i koosturi ja saate hõlpsalt käivitada uue pdfTeXtoolchaini. Kuigi mitte, loob sphinx-quickstart programm suurepärase Makefile'i ja saate kasutada amake.bat faili, mis teeb elu teie vajaduste jaoks lihtsamaks.
See võib genereerida HTML-dokumente teie valitud loomisindeksi alusel. Neid saab teha, käivitades make oma looja sildile. (Need võivad sisaldada ka toctree direktiive, vajadusel saate luua tugevalt pesastatud hierarhiaid.)
Kõige esimene seadistus¶
Iga direktiiv otsustab, kas see postituseks panna või mitte, ja saate teada, kuidas sellega toime tulla. Blogid järgivad valikuid, vastasel juhul on vastuväited tühi rida. Themaxdepth on selline valik teie toctree direktiivile.
See it-kataloog sisaldab ka uusimat Sphinxi konfiguratsioonidokumenti conf.py, kus saate konfigureerida kõiki tahke alates sellest, kuidas Sphinx teie lähtekoodi loeb, ja saate luua oma dokumente. Siiski kopeerivad nad uued reStructuredText lähtekoodifailid funktsionaalsuse loendi all olevasse uusimasse _supply kausta. Seega loob it-koostaja iga reStructuredText dokumendi jaoks tekstirakenduse. See on peaaegu sama mis uus reStructuredText lähtekood, kuid suurem osa uusimast märgistusest on parima loetavuse tagamiseks eemaldatud. Saadaval olevate valikute kohta vaadake exudate_files ja Exudate'i tootlikkuse osa Alternatiivid.
Milline koostaja pakub sarnast väljundit kui eraldiseisev HTML-koostaja, aga genereerib ka GNOME Devhelp tugidokumendi, mis võimaldab uuel GNOME Devhelp vaatajal sinna sisse pääseda. Näiteks uusim documentmarkup/rest.rst ei vii väljundfailini markup/others.html, vaid pigem markup/rest/index.html. Produkt on tegelikult HTML-dokumentidega kataloog, kus iga dokumendi nimi on index.html ja see on loetletud alamkataloogis nimega näiteks veebilehe identiteet. Uue koostaja "nimi" tuleb anda uuele -Yards-ile, vastasel juhul -b käsurea valikutele sphinx-create'is, et valida koostaja.