Blogid
Uus näide on mõeldud Sphinxi algajatele, kes on valmis õppima ideede loomise ja struktureerimise põhitõdesid. Samuti saate oma Giti repo pildi tar.gz või zip formaadis. Dockeri piltide kasutamisel uurige palun Dockeri fookust käsul, et käivitada Sphinxi käske.
Allalaaditavatele andmetele viitamine¶
Uus järelliide kõigile tüüpilistele andmetele. Uusim pickle Builder on sellest hea alamklass. Peate määrama, milliseid faile saab kasutada ja mis suunavad profiile man_users paigutuse väärtuse kaudu.
Põhjalike API-soovituste koostamine¶
Millist koostajat saab kasutada Sphinx/Docutilsi uue „Audience to Transformto Autoriks” toru silumiseks? Iga kõrgeima kvaliteediga faili või alamkataloogi jaoks loob ühe .pot kataloogi paigutuse. Seega loob koostaja gettext-layout sisukatalooge.
Vaadake kõigi lisalinkide stabiilsust. Genereerige UNIX-i võimaluste jaoks groff-vormingus juhendlehti. Milline osa sobib suurepäraselt funktsiooni standard_character jaoks? Mitmel juhul võite potentsiaalselt muuta "any" konkreetseks märgiks. Kui kasutate väljendit, mida heas sõnastikus pole, saate loomise ajal hoiatuse. Lingi soovitud failile; uue faili nimetus on suhteline või absoluutne tee ning see on alati eksemplaride suhtes tundlik ja ebamugav, isegi Windowsi jaoks.
Pane tähele, et rinohtype pakub otsest PDF-i koostajat. Seega saad luua kehtiva abipublikatsiooni, mille koostaja vajab käsureaüksust hiutil, mis on saadaval ainult Maci operatsioonisüsteemis X 10.6 ja uuemates versioonides. Need kaustad unustatakse kõigis teistes dokumentatsioonimudelites.
Uusima koostaja toetatud MIME-tüüpi fotovormingute menüü. Pildidokumendid ilmuvad siin. Kui vajate linke oma dokumentatsiooni andmetele, saate seda teha sphinx.ext.intersphinx abil. Pythoni https://trino-casino.com/et/login/ parooli dokumenteerimisel on tavaline paigutada palju faile lähteandmete sisse failiahelasse. See ei tähenda, et failil on tegelikud kirjed enumerate(); Sphinx suudab need leida ja neile lingi luua. See märgendus võimaldab luua seose enumerate() uusimate failidega.
Muude huvitavate asjade ristviitamine¶
Näiteks Pythoni sisemise vormi enumerate() dokumenteerimiseks looksite selle oma lähtekoodi andmetest. Hea näitena, kui vaatate uut HTML-tüüpi, saate testida uut lähtekoodi, et see dokumenteeriks – kasutage külgribal olevat linki „Näita päritolu“. Igaüks saab luua uues toctree's loetletud faile ja luua postitusi ning nende jaotiste pealkirjad lisatakse (uue maxdepth height'iga) kohast, kus toctree direktiiv asub. Lisatavad dokumendid on esitatud failisiltides, mis tähendab, et peate failiidentiteedi laiendamisest loobuma ja kaldkriipse (/) kasutama indeksite eraldajatena. See on üks osa Sphinxi funktsioonidest, mis laiendavad reStructuredText'i, mis on meetod mitme faili ühendamiseks ühte failihierarhiasse.
Enne mainisime, et uusim conf.py dokument kontrollib, kuidas Sphinx teie artikleid töötleb. Iga veebisaidi nime jaoks on kindlasti eraldi reeglid, mis määravad, kuidas uued allkirjad välja näevad, ja et uus vormindatud fail näeks välja aus või et luua spetsiifilisi sätteid, näiteks linke parameetritüüpidele, nt C/C++ domeeninimedele. Direktiivi uusim argument on teie kirjeldatud sihtmärgi kaubamärk, sisu on selle kirjed.
Milline koostaja pakub sarnast toodangut kui iseseisev HTML-koostaja, aga loob ka Qt abifailide kogumise teenusefaile, mis võimaldavad uusimal Qtcollection generaatoril neid koguda? See koostaja pakub sarnast toodangut kui iseseisev HTML-koostaja, aga loob ka HTML-i abil tugifaile, mis võimaldavad uuel Microsoft HTML HelpWorkshopil neid teie CHM-faili koguda. See on HTML-koostaja, mis ühendab kogu teie investeeringu tõhusaks failiks. (Loomulikult töötab see ainult väiksemate ideedega.) Uusimat faili nimetatakse juurfailiks.
Laienduste abil lisatakse tõenäoliselt palju rohkem disainereid. Need on Sphinxi sisekesksed arendajad. See roll püüab teha kõik endast oleneva, et leida kehtiv aadress viitetekstisõnumi omamiseks. See ei pea olema samas dokumendis, kuna terminimärgistus on näiteks Pythoni dokumentatsioonis olemas ülemaailmne sõnastik faili glossary.rst kohta. Hea sõnastik luuakse sõnastikudirektiivi abil, mis sisaldab klassifikatsiooninumbrit koos terminoloogia ja definitsioonidega. Seega luuakse seos alternatiivse direktiiviga, olenemata sellest, kas see on saadaval.
Intersphinxiga mängimiseks peate selle aktiveerima conf.py failis, lisades oma laienduste loendisse uue stringi 'sphinx.ext.intersphinx' ja seadistama intersphinx_mapping konfiguratsiooni. Uued failid salvestatakse vaikimisi UTF-8-s, kuna need kuvatakse kodeerimisdeklaratsioonis esimeses vahemikus. Pidage meeles, et uus fail kasutab Pythoni lauseehitust ahela, numbri, loendi jms jaoks. Hea konfiguratsiooniväärtuse kohandamiseks, mis ei ole sphinx-quickstart'i abil automaatselt lisatav, looge lihtsalt uus määramine. Uusim Pythoni veebisaidi nimi on ka standarddomeen, seega ei pea te veebisaidi nimele uut märgistust ette lisama. ReStructuredText laiema kaasatuse saamiseks, et saaksite reStructuredTexti ja Sphinxi abil täiendavat märgistust lisada.
