Az autosummary által létrehozott összefoglaló weboldal¶ És ismét látni fogja, hogy a create html futtatása után a legújabb kimenet ugyanaz lesz, mint korábban. A bemutató korábbi részében manuálisan dokumentált egy kiváló Python függvényt a Sphinxen belül. Bár nem, a conf.py fájl egy másik listában, a vadonatúj konfigurációs könyvtárban lehet. A Sphinx.ext.intersphinx az intersphinx saját funkcióinak teljes diszfunkciójához.

Az új generátor futtatása¶ | RoyalGame alkalmazás számítógépre

A Toctree egy nagyszerű reStructuredText direktíva, egy rendkívül sokoldalú jelölőnyelv. Miután ezzel is elkészültél, elolvashatod a telepítői kiadványt, majd az új bevezetést a Sphinx által használt alapértelmezett jelölőnyelvi formátumba, a reStructuredText-be. Más nyelvek natívan elérhetők a Sphinxben a manuális kóddokumentációhoz, de ezekhez kiterjesztésekre van szükség az automatizált kóddokumentációhoz, mint például az Inhale. A Sphinx kóddokumentációval kapcsolatos lehetőségeinek bemutatásához Pythont fogsz használni, amely támogatja az automatizált dokumentumokat. Létrehozol egy kitalált szoftverkönyvtárat, hogy véletlenszerű étkezési képleteket hozz létre, amelyek útmutatóként szolgálnak a folyamat során, a biztonságos dokumentálás érdekében. A panelek tartalmazhatnak narratívát, kézzel írott fájlokat és automatikusan generált API-fájlokat.

Más, nagy érdeklődésre számot tartó dolgok kereszthivatkozása¶

A szerializációs készítő részleteivel kapcsolatban tájékozódhat az új kimeneti formátumról. A készítő egy komponenst használ a legújabb Python szerializációs API-k (pickle, simplejson, phpserialize és mások) megvalósításához a generált HTML dokumentumok eltávolításához. Meg kell határoznia, hogy mely adatokat használja a Texinfo dokumentumokban, és hogy a texinfo_documentsconfiguration segítségével mely adatokat használja fel. A készítő Texinfo fájlformátumokat biztosít, amelyeket a makeinfo rendszer fájlformátumba menthet. A készítő ugyanazt a kimenetet állítja elő, mint az önálló HTML készítő, de egy epub formátumot is létrehoz a feliratkozóknak.

Minden egyes direktíva meghatározza, hogy lehetnek-e ellenvetései, és ha igen RoyalGame alkalmazás számítógépre , hány. Az érvek személyesen, dupla végponttal kerülnek bemutatásra az irányelv identitását követően. A gyökérdokumentum fő célja, hogy nagyszerű üdvözlőlapként szolgáljon, és tartalmazza az „étkezőasztal a tartalomerdőtől távol” (vagy toctree) gyökerét. A dokumentum célja, hogy azonnali képet adjon arról, hogy mit próbál ki a Sphinx, és hogyan használhatja azt.

Egy webhely néhány hozzá tartozó objektumtípus, részletesen leírva a létrehozandó objektumok jelölőnyelvével és hivatkozási leírásaival. A Make latexpdf az új Latex szerkesztőt használja, és könnyen meghívhatja az új pdfTeX eszközláncot. Bár nem, a sphinx-quickstart program egy nagyszerű Makefile-t hoz létre, és létrehozhat egy amake.bat fájlt, amely még könnyebbé teszi az életet.

Ez HTML dokumentumokat fog létrehozni a kiválasztott létrehozási indexben. Ezeket a generate parancs futtatásával lehet végrehajtani a saját szerkesztő termináljára. (Maguknak is lehetnek toctree direktíváik, ami azt jelenti, hogy szükség esetén jelentősen beágyazott hierarchiákat hozhatsz létre.)

Első beállítás¶

Minden direktíva eldönti, hogy engedélyezi-e a tartalomként való felhasználást, és hogyan kezelje azt benne. A tartalom egy üres sor után követi az opciókat vagy argumentumokat. A maxdepth valójában egy opció a toctree direktívában.

Ez az it könyvtár tartalmazza a legújabb Sphinx konfigurációs dokumentumot, a conf.py-t is, ahol minden aspektust konfigurálhatsz, azon kívül, hogy a Sphinx hogyan olvassa be az ajánlatodat és hogyan hozza létre a rekordokat. Ugyanakkor a legújabb reStructuredText forrásfájlokat a termelékenységi index legújabb _offer listájába másolják. Az it builder minden egyes reStructuredText dokumentumhoz biztosít egy szövegfájlt. Ez majdnem megegyezik az új reStructuredText forrással, de a legújabb jelölések nagy részét eltávolították a jobb olvashatóság érdekében. Az elérhető lehetőségekért keresd meg az exudate_data fájlt és az Exudate termelékenységre vonatkozó lehetőségek című fejezetet.

Tehát a létrehozója azonos termelési folyamatot biztosít, mint az önálló HTML-készítő, de létrehoz egy GNOME Devhelpsupport dokumentumot is, amely lehetővé teszi a legújabb GNOME Devhelp megjelenítő számára, hogy hozzáférjen hozzá. Például az új documentmarkup/others.rst nem egy markup/others.html hatékonysági dokumentumot indít el, hanem a markup/rest/directory.html-t. A hatékonyság érdekében próbáljon ki egy HTML-fájlokat tartalmazó könyvtárat, ahol minden fájl neve directory.html, és egy alkönyvtárban szerepel, például a webcímükkel megegyező címmel. A legújabb létrehozó „nevét” meg kell adni a sphinx-make új -M vagy -b parancssoros kapcsolóinak a létrehozó kiválasztásához.