Sisu
Uus kursus on mõeldud Sphinxi algajatele, kes soovivad õppida ideede loomise põhitõdesid ja kuidas neid organiseerida. Samuti saate Giti repo pildi installida nii tar.gz kui ka zip-vormingusse. Dockeri piltide kasutamisel uurige palun Dockeri tööd käsuga Sphinxi käskude käivitamiseks.
24 Casino rakenduse sisselogimine: Allalaaditavatele dokumentidele viitamine¶
Kõigi tavaliste andmete uus järelliide. Värske 24 Casino rakenduse sisselogimine hapukurgi looja proovib sellest suurepärast alamklassi. Peate määrama, milliseid faile kasutada ja millised juhised lehtedel on theman_users seadistuse väärtuse all.
Põhjalike API-kirjete loomine¶
Seda it-koostajat kasutatakse uusima Sphinx/Docutils'i tuubi „Viewer to Transform to Autor” silumiseks. Iga suurima kõrgusega faili või alamkataloogi kohta luuakse üks .pot kataloogimall. Seega pakub it-koostaja gettext-build sisukatalooge.
Lugege kõigi täiendavate veebisaidilinkide stabiilsust. Tehke groff-stiilis näpunäited, et omada UNIX-i valikuid. See osa on hea kandidaat standard_role'i vormile. Mitme sihtmärgi korral võite asendada „any” konkreetse tähemärgiga. Kui kasutate terminit, mida heas sõnastikus pole selgitatud, saate ehituse ajal hoiatuse. Lingi määratud failile; uue faili nimi on perekonnanimi või absoluutne tee, mis on alati tõstutundlik, isegi teie Windowsi jaoks.
Pane tähele, et rinohtype pakub kohest PDF-i koostajat. Nii saad luua õigustatud juhendi, mille koostamiseks on vaja käsurea tööriista hiutil, mis on piiratud Maci arvutiga, mille operatsioonisüsteem on X 10.6 või uuem. Kõik teised dokumendibrändid ignoreerivad seda tüüpi faile.
Uue looja toetatud MIME-tüüpi pildivormingute loend. Fotofailid näevad välja nagu siin. Kui soovite luua linke, et andmeid oma dokumentatsioonist otsida, saate seda teha sphinx.ext.intersphinx abil. Pythoni koodi dokumenteerimisel on üsna tavaline, et allikfailides, dokumentide ahelas, on palju kirjeid. See ei tähenda, et dokumendil on tegelikud dokumendid, mis on forenumerate(); Sphinx saab need leida ja nendega seose luua. See märgend saab luua lingi enumerate() uute kirjetega.
Muu huvipakkuva teabe ristviitamine¶
Näiteks Pythoni tsentreeritud vormi enumerate() dokumenteerimiseks peaksite selle lisama ühte oma lähtekoodifailidest. Näiteks kui vaatate uusimat HTML-i versiooni, võite proovida uut lähtekoodifaili – kasutage külgribal olevat konksu „Tell you supply“. Igaüks saab luua uusimas toctree's loetletud faile ja saate lisada postitusi ning nende pealkirjad registreeriti (uue maxdepth taseme ümber) kohas, kuhu toctree direktiiv paigutati. Esitatavad failid on failinimedena, mis tähendab, et peate faili identiteedi laiendist väljuma ja proovima kaldkriipsude (/) saatmist loendieraldajatena. See on üks peamisi asju, miks Sphinx suurendab reStructuredTexti, mis on viis mitme faili ühendamiseks ühe astme kaugusel failidest.
Enne mainisin, et uus conf.py fail kontrollib, kuidas Sphinx teie artikleid töötleb. Iga veebisaidi nime jaoks on eraldi reeglid selle kohta, kuidas uued allkirjad välja näevad, ja tehke uus vormindatud funktsionaalsuse otsing ilusaks, vastasel juhul lisage spetsiifilisi funktsioone, näiteks linke parameetrimudelitele, nt C/C++ domeeninimedes. Teie direktiivi uus konflikt on teie kirjeldatud sihtmärgi kaubamärk, sisu on sellest tulenevad dokumendid.
See looja pakub sama tõhusust kui eraldiseisev HTML-i koostaja, aga loob ka Qt-kogumi abifaile, mis võimaldavad uusimal Qt-kogumi generaatoril neid koguda. See looja pakub sama väljundit kui iseseisev HTML-i koostaja, aga loob ka HTML Assist abifaile, mis võimaldavad uusimal Microsoft HTML HelpWorkshopil neid CHM-faili jaoks koguda. See on entusiastlik HTML-i koostaja, mis koondab kogu projekti ühte funktsionaalsusfaili. (Ütlematagi selge, et see töötab ainult kiiremate programmidega.) Uut faili nimetatakse ressursifailiks.
Rohkem arendajaid võivad olla täiendavad laiendused. Need on Sphinxil põhinevad arendajad. See mugavusosakond püüab oma parima anda, et leida oma viitetekstile suurepärane ja õigustatud sihtmärk. See ei pea olema samas failis kui märgistuse definitsioon, sealhulgas Pythoni dokumentatsioonis on üks rahvusvaheline sõnastik faili glossary.rst kohta. Hea sõnastik luuakse sõnastiku direktiivi abil, mis sisaldab klassifikatsiooniloendit koos terminoloogia ja definitsioonidega. See loob lingi teisele direktiivile, kui see on saadaval.
Intersphinxiga mängimiseks peaksite selle aktiveerima conf.py-s, lisades oma laienduste loendisse uue järjestuse 'sphinx.ext.intersphinx' ja määrama selle intersphinx_mapping konfiguratsiooniväärtuses. Uus fail salvestatakse UTF-8-s automaatselt, edastades selle kodeerimisdeklaratsioonist esimesel real. Pidage meeles, et uus fail kasutab stringide, numbrite, kirjete jms jaoks Pythoni lauseehitust. Konfiguratsiooniväärtuse kohandamiseks, mida sphinx-quickstart automaatselt ei lisa, määrake lihtsalt uus ülesanne. Uusim Pythoni domeen ja sageli on see vaikedomeen, mis tähendab, et te ei pea domeeninimele uut märgistust ette lisama. ReStructuredText pakub põhjalikumat sissejuhatust reStructuredTexti ja Sphinxi lisamärgistuse kohta.
