Uus kursus on suunatud Sphinxi algajatele, kes on valmis õppima programmide loomise ja korraldamise põhitõdesid. Saate installida oma Giti repo hetktõmmise tar.gz või zip struktuuri sisse. Dockeri piltide kasutamisel proovige Dockeri fookust käsul, et käivitada Sphinxi käske.

Allalaaditavatele dokumentidele viitamine¶: Trinocasino partneri sisselogimise registreerumine

Uusim järelliide kõigile tavalistele andmetele. Uus hapukurgi looja on selle hea alamklass. Peate määrama, milliseid andmefaile saab kasutada, ja see juhend loeb läbi theman_profiles konfiguratsiooni.

Põhjalike API-viidete loomine¶

Et it Builderit saab kasutada uue Sphinx/Docutilsi „Reader to Transform to Writer” tuubi silumiseks. Iga suurema kõrgusega faili või alamkataloogi jaoks luuakse eraldi .pot-kataloogi paigutus. Et it Builder pakub gettext-layout sisukatalooge.

Vaadake kõigi väliste linkide terviklikkust. Looge UNIX-i valikute jaoks groff-stiilis käsitsi kasutajad. See osa on suurepärane kandidaat standard_character režiimi omamiseks. Mitmete plaanide puhul saate muuta „any” kindla rolli jaoks. Kui kasutate väljendit, mida pole sõnastikus mainitud, saate genereerimise ajal hoiatuse. Seos soovitud failiga; uue faili silt võib olla perekonnaliige või absoluutne tee ja see on alati suur- ja väiketähtedega seotud ning tundlik, eriti akna suhtes.

Pane tähele, et rinohtype'iga on saadaval kohese PDF-i loomise tööriist. Selleks, et luua usaldusväärne abimaterjal, on vaja käsurea tööriista hiutil, mis on piiratud Mac OS X 10.6 ja uuemate versioonidega. Kõik muud dokumenditüübid ignoreerivad seda tüüpi kaustu.

Uue looja toetatud MIME-tüüpi fototüüpide loend. Fotofaile otsitakse Trinocasino partneri sisselogimise registreerumine nende siin ilmumise järjekorras. Kui soovite luua linke näiteks oma dokumentatsiooni failidele, saate seda teha käsuga sphinx.ext.intersphinx. Pythoni parooli dokumenteerimisel on üsna tavaline paigutada palju dokumente lähtedokumentide sisse failiahelasse. Pole tähtis, milline fail sisaldab tegelikke faile, mida enumerate() kasutab; Sphinx leiab need üles ja loob nendega seose. See märgendus saab luua seose enumerate() uusimate dokumentidega.

Ristviitamine teistele huvitavatele üksustele¶

Näiteks Pythoni alusdokumendi dokumenteerimise hõlbustamiseks – säte enumerate() sees – võiksite selle lisada ühele oma lähteandmetest. Näiteks kui jälgite uut HTML-tüüpi, saate vaadata selle dokumenteeritud lähtekoodi – kasutage külgribal olevat konksu „Näita ressurss“. Nüüd saate luua uude toctree'sse paigutatud failid ja lisada sisu ning nende jaotiste pealkirjad registreeritakse (kuni uue maxdepth tasemeni) sellest kohast, kuhu toctree direktiiv paigutatakse. Esitatavad failid esitatakse failinimede ajal, mis tähendab, et loobute failinime laiendamisest ja kasutate kataloogide eraldajatena kaldkriipse (/). See on üks osa funktsioonidest, mida Sphinx lisab reStructuredTextile, mis on meetod mitme andmehierarhia ühendamiseks.

Enne väitsime, et uus conf.py dokument kontrollib, kuidas Sphinx teie kirjutisi töötleb. Veebisaidi nimele võivad kehtida erieeskirjad olenevalt sellest, kuidas uued allkirjad välja näevad, ja selle asemel võivad olla uue vorminguga failiotsing või lisada spetsiifilisi funktsioone, näiteks linke parameetritüüpidele, nt C/C++ domeeninimedele. Teie direktiivi uusim konflikt on teie kirjeldatud sihtmärgi allkiri, kiri on selle failid.

Seega pakub it Builder võrreldavat väljundit kui iseseisev HTML-i looja, aga loob ka Qt abikogu abifaile, mis võimaldavad uuel Qtcollection generaatoril neid koguda. Seega loob it Builder sama väljundi kui iseseisev HTML-i looja, aga loob ka HTML Let teenuse andmefaile, mis võimaldavad uuel Microsoft HTML HelpWorkshopil neid CHM-faili jaoks koguda. See on HTML-i looja, mis koondab kogu teie investeeringu tootmisfaili. (Loomulikult töötab see ainult väiksemate projektidega.) Uut faili nimetatakse juurfailiks.

Laienduste abil saab lisada palju rohkem disainereid. Need põhinevad Sphinxi ehitajatel. Seega püüab mugavuse osa oma parima, et näha oma viiteteksti jaoks head aadressi. See ei pea olema samas dokumendis, kuna sõnamärgistusel, sealhulgas Pythoni dokumentatsioonil, on üks globaalne sõnastik failist glossary.rst. Sõnastik luuakse sõnastikudirektiivi abil, mis sisaldab kirjeldusnumbrit sõnade ja definitsioonide kohta. See loob seose teise direktiiviga, kui see on saadaval.

Intersphinxiga mängimiseks peate need conf.py failis aktiveerima, lisades laienduste loendisse uue stringi 'sphinx.ext.intersphinx' ja seadistama intersphinx_mapping konfiguratsiooni väärtuse. Uued failid on automaatselt UTF-8-s kaitstud, kuna need on kodeeritud deklaratsiooniga esimeses vahemikus. Pidage meeles, et uus fail kasutab Pythoni süntaksit ahela, numbrite, loendi jms jaoks. Hea konfiguratsiooniväärtuse kohandamiseks, mis pole koheselt lisatav, lisage lihtsalt uus ülesanne. Uusim Pythoni domeen on ka tavaline veebisaidi nimi, mis tähendab, et te ei pea veebisaidi nimele uut märgistust ette lisama. ReStructuredText pakub laiemat lisandit, mis aitab teil reStructuredTexti ja Sphinxist lisatud märgistust kasutada.