See värske õppetund on mõeldud teie Sphinxi algajatele, kes on valmis Trinocasino rakendus iPhone’ile õppima ideede kujundamise ja struktureerimise põhitõdesid. Võite alla laadida Giti repo pildi nii tar.gz kui ka zip struktuuris. Dockeri fotode kasutamisel nautige Dockeri tööd käskudega, et käivitada Sphinxi käske.

Trinocasino rakendus iPhone’ile – Veebipõhistele andmefailidele viitamine¶

Uus järelliide kõigile tavalistele dokumentidele. Uus hapukurgi looja on selle alamklass. Peate määrama, millised andmed lisatakse kasutajaid man_users paigutuse väärtuses juhendavatesse andmetesse.

Täielike API viidete loomine¶

Seda, et selle loojat saab kasutada uue Sphinx/Docutilsi „Viewer to Convert to Creator” toru silumiseks. Iga kõrgeima faili või alamkataloogi jaoks luuakse eraldi .pot-faili kujundus. See looja pakub gettext-tüüpi sõnumikatalooge.

Sirvige kõigi väliste linkide terviklikkust. Luua groff-stiilis kasutajad UNIX-i suvandite omamiseks. Milline märk sobib režiimi standardosa jaoks? Mitme eesmärgi korral saate muuta „mis tahes“, et saada teatud osa. Kui kasutate fraasi, mida sõnastikus pole selgitatud, saate genereerimise ajal hea hoiatuse. Seos soovitud failiga; uue faili nimi võib olla lähedane sugulusnimi või absoluutne_tee ja see on alati olukorrapõhine, isegi Windowsi puhul.

Pange tähele, et otse PDF-failide koostajale pakutakse utiliiti rinohtype. Õigesti kasutatava abimaterjali loomiseks vajab koostaja käsurea tööriista hiutil, mis on saadaval ainult Mac OS X 10.6 ja uuemate versioonide puhul. Teised dokumendibrändid jätaksid sellised kaustad tähelepanuta.

Uue koostaja toetatud MIME-tüüpi pildivormide menüü. Pildifailid ilmuvad siin ostult. Kui soovite luua linke näiteks oma dokumentatsiooni andmefailidele, saate seda teha sphinx.ext.intersphinx abil. Pythoni parooliga dokumenteerimisel on väga tavaline, et allikdokumentides, dokumendistringides, on palju dokumente. See ei lähe arvesse ja failis on ehtsad dokumendid forenumerate(); Sphinx leiab need ja loob neile lingi. See märgendus loob seose uute kirjetega enumerate()-st.

Muude huvitavate asjade ristviitamine¶

Näiteks Pythoni dokumendi keskpunktis enumerate() sättesse lisamiseks peaksite selle lisama lähtekoodifailide väärtusele 1. Hea näitena võite uut HTML-tüüpi vaadates testida uut lähtekoodi, mille jaoks dokumenti vajate – kasutage külgribal linki „Teavita oma allikat“. Igaüks saab luua uude teemapuusse lisatud dokumente ja lisada artikleid ning nende osade pealkirjad ühendatakse (kuni uue maxdepth tippu) kohas, kuhu teemapuu direktiiv paigutatakse. Lisatavad dokumendid esitatakse failide siltidega, mis lühidalt tähendab, et logite välja failiidentiteedi laiendamisest ja kasutate kataloogide eraldajatena kaldkriipse (/). See on üks osa funktsioonidest, mida Sphinx lisab reStructuredTexti, mis on viis mitme faili ühendamiseks ühte hierarhiasse failidest eraldi.

Varem väitsime, et uus conf.py dokument kontrollib täpselt, kuidas Sphinx teie artikleid töötleb. Iga domeeninime jaoks kehtestage spetsiaalne seadusandlus, mis põhineb sellel, kuidas uued allkirjad välja näevad, ja tehke uusim vormindatud väljundotsing väga selgeks või lisage spetsiifilisi sätteid, näiteks linke parameetrite versioonidele, nt C/C++ domeeninimedele. Direktiivi uus lahknevus on teie kirjeldatava objekti kaubamärk, sisu on selle kirjed.

See koostaja toodab sarnast väljundit kui eraldiseisev HTML-koostaja, kuid genereerib ka Qt abifailide tugifaile, mis võimaldavad uuel Qtcollection koostajal neid koguda. See koostaja pakub samaväärset jõudlust kui eraldiseisev HTML-koostaja, kuid loob ka HTML Assist tugifaile, mis võimaldavad uuel Microsoft HTML HelpWorkshopil neid ühte CHM-faili koguda. See on entusiastlik HTML-koostaja, mis koondab kogu projekti teie jõudlusfaili. (Loomulikult töötab see ainult väiksemate pakettidega.) Uusimat faili nimetatakse juurfailiks.

Palju rohkem arendajaid lisab laiendusi. Nad töötavad Sphinxi disainerite sees. Seega püüab see mugavuse roll leida oma viitetekstisõnumi jaoks õige aadressi. See ei pea olema samas dokumendis, kuna see kasutab sõnastikupõhist märgistust, näiteks Pythoni dokumentatsioonis on glossary.rst-failis ülemaailmne sõnastik. Sõnastik luuakse sõnastikudirektiivi abil, millel on klassifikatsiooninumber koos terminite ja definitsioonidega. See loob seose valikudirektiiviga, kui see on saadaval.

Intersphinxi uurimiseks peate selle aktiveerima conf.py failis, lisades uue stringi 'sphinx.ext.intersphinx' laienduste loendisse ja salvestades intersphinx_mapping konfiguratsiooni. Uus fail salvestatakse automaatselt UTF-8 kodeeringus, kuna see kuvatakse esimesel real oleva kodeerimisdeklaratsiooni tõttu. Pidage meeles, et uus fail kasutab Pythoni lauseehitust ahela, koguse, loendi jne omamiseks. Hea konfiguratsiooniväärtuse kohandamiseks, mis ei ole koheselt sphinx-quickstart'i poolt lisatav, lisage lihtsalt täiendav ülesanne. Uus Pythoni veebisaidi nimi on ka tavaline domeen, mis tähendab, et te ei soovi uuele märgistusele oma domeeni eesliidet lisada. ReStructuredText sügavama lisamise jaoks, et saaksite reStructuredTexti ja märgistust Sphinxi poolt laiendada.