See värske koolitus on mõeldud Sphinxi algajatele, kes on valmis õppima projektide loomise põhitõdesid ja olete selleks valmis. Samuti saate alla laadida oma Giti repo pildi tar.gz või zip-vormingus. Dockeri piltide kasutamise ajal proovige Dockeri tööga järjestikku mängida, et saaksite Sphinxi käske käivitada.

Parim sissemakseta YoyoSpins – Allalaaditavatele failidele viitamine¶

Uusim järelliide kõigile tavalistele andmefailidele. Uus pickle creator on selle parim sissemakseta YoyoSpins suurepärane alamklass. Peate määrama, millised andmefailid leitakse, ja need näpunäited juhendavad kasutajaid theman_pages konfigureerimisel.

Täielike API viidete loomine¶

Millist koostajat kasutatakse uue Sphinx/Docutilsi toru „Viewer to Transform to Blogger” silumiseks? Iga kõrgeima kõrgusega dokumendi või alamkataloogi jaoks luuakse individuaalne .container loendi paigutus. Selle koostaja pakub gettext-stiilis sõnumikatalooge.

Vaadake kõigi väliste tagasilinkide stabiilsust. Looge groff-stiilis juhtprofiilid UNIX-süsteemide omamiseks. Seega on see roll suurepärane kandidaat funktsiooni standard_part omamiseks. Mitmest paketist erinevas olukorras saate muuta „mis tahes“, et saaksite konkreetse rolli. Kui kasutate terminit, mida pole heas sõnastikus mainitud, saate loomise ajal hea hoiatuse. Seos määratud failiga; uue faili nimi on absoluutse tee lähedane sugulusnimi ja see on alati eksemplaritundlik, isegi ekraanil.

Pange tähele, et rinohtype on pakkunud peamise PDF-i koostaja. Õige abijuhendi loomiseks on vaja käsureaüksust hiutil, mis on saadaval ainult Mac OS X 10.6 ja uuemate versioonide jaoks. Need failid võivad teistes dokumentatsioonimudelites kahe silma vahele jääda.

Uusima koostaja toetatud MIME-tüüpi fototüüpide loend. Andmete visualiseerimine proovib tunduda, kus need siin kuvatakse. Kui soovite luua linke, mis aitavad teil näiteks dokumente teie dokumentatsioonist eemale pääseda, saate seda teha sphinx.ext.intersphinx abil. Pythoni koodi kirjutamisel on üsna tavaline, et lähtekoodifailides, dokumentide stringides, on palju kirjeid. See ei lähe arvesse ja see fail sisaldab tegelikke faile forenumerate(); Sphinx saab need leida ja luua nendega seose. See märgendus saab luua seose enumerate() uue dokumendiga.

Ristviitamine muudele väga huvipakkuvatele asjadele¶

Näiteks documentPythoni režiimi enumerate() keskele paigutamiseks võite selle luua vähemalt ühele oma lähtekoodifailidest. Näiteks kui vaatate uut HTML-versiooni, võite proovida uut lähtekoodifaili – kasutage külgribal olevat konksu „Teata ressursist“. Igaüks saab luua faile, mille olete uude toctree'sse lisanud, ja te lisate failid ning nende päised ühendatakse (uue maxdepth kõrguse ümber) kohas, kuhu toctree direktiiv paigutatakse. Lisatavad failid on esitatud failinimedena, mis lühidalt tähendab, et logite välja failinimelaiendist ja kasutate loendi eraldajatena kaldkriipsusid (/). See on üks osa funktsioonidest, mida Sphinx pakub reStructuredTextile, mis on vahend mitme faili ühendamiseks vähemalt ühe sammu kaugusel failidest.

Enne kui ma väitsin, et uus conf.py fail reguleerib seda, kuidas Sphinx teie kirjutisi töötleb. Iga domeeninime jaoks on kindlasti eraldi eeskirjad selle kohta, kuidas uusimad allkirjad välja näevad ja kuidas uusim vormindatud väljund ilus välja näeb. Kui te ei lisa C/C++ domeeninimedesse teatud elemente, näiteks linke parameetritüüpidele, elizabeth.grams. Teie käsu uus argument on teie kirjeldatava objekti kaubamärk, sisu on selle paberimajandus.

See looja pakub sama tootlikkust kui eraldiseisev HTML-i koostaja, aga loob ka Qt Let'i vahemiku abifaile, mis võimaldavad uuel Qtcollection generaatoril neid koguda. See looja pakub sama tootlikkust kui eraldiseisev HTML-i koostaja, aga loob ka HTML Let'i abifaile, mis võimaldavad uuel Microsoft HTML HelpWorkshopil neid teie suurepäraseks CHM-failiks koguda. See on entusiastlik HTML-i koostaja, mis ühendab kogu teie töö tootmisfailiks. (Muidugi töötab see ainult lühemate projektidega.) Uue faili nimi on nagu juurfailil.

Tõenäoliselt lisanduvad disaineritele laiendused. Need esindavad Sphinxi disainerite baasi. See mugavusfunktsioon püüab paremini leida sobiva sihtmärgi oma viiteteksti jaoks. See ei pea olema samas failis, kuna sõnastiku märgistus, sealhulgas Pythoni dokumendid, pakuvad globaalset sõnastikku faili glossary.rst. Sõnastik luuakse glossary direktiivi abil, mis sisaldab tähenduste loendit koos terminite ja definitsioonidega. See loob lingi lahendusdirektiivile, kui see on saadaval.

Intersphinxi uurimiseks peaksite selle käivitama conf.py failis, lisades laienduste loendisse uusima stringi 'sphinx.ext.intersphinx' ja sisestama intersphinx_mapping konfiguratsiooni väärtuse. Uus fail proovib automaatselt UTF-8-s kodeerida, nagu on näidatud esimese rea kodeerimisdeklaratsioonis. Pidage meeles, et uus fail kasutab Pythoni süntaksit ahela, arvude, loendi jms jaoks. Hea konfiguratsiooniväärtuse kohandamiseks, mis ei ole sphinx-quickstart'i poolt koheselt lisatav, sisestage lihtsalt uus projekt. Uus Pythoni veebisaidi nimi on tavaliselt standarddomeen, seega te ei pea oma veebisaidi nimele uut märgistust ette lisama. ReStructuredText on reStructuredTextile põhjalikum täiendus ja Sphinxi märgistus.