Sphinx egy olyan eszköz, amely megkönnyíti, hogy hozzon létre az intelligens és szép dokumentációját Python projektek (vagy más dokumentumokat, amely több reStructuredText forrásból), írta Georg Brandl. A projekt eredetileg azért jött létre, hogy fordítsa le az új Python dokumentációt, de most tisztították meg, abban a reményben, hogy hasznos lesz, hogy számos más projektben.
Sphinx használja reStructuredText mint a jelölőnyelv, és sok erősségeit jönnek a hatalom és őszinteség reStructuredText és elemzési és fordítási suite, a Docutils.
Bár még mindig folyamatos fejlesztés alatt, akkor az alábbi funkciók már jelen van, jól működik, és látható "akcióban" a Python docs:
& Nbsp; * Kimeneti formátumok: HTML (beleértve a Windows HTML Help) és a LaTeX, a nyomtatható PDF verzió
& Nbsp; * Kiterjedt kereszthivatkozások: szemantikus jelölés és automatikus linkeket funkciók, osztályok, szószedet és hasonló információkat
& Nbsp; * hierarchikus: könnyű meghatározása a dokumentum fát, automatikus linkeket testvérek, szülők és gyerekek
& Nbsp; * Automatikus indexek: általános index, valamint a modul index
& Nbsp; * Code kezelése: automatikus kiemelés segítségével Pygments kiemelő
& Nbsp; * Különböző kiterjesztések elérhetők, például a automatikus tesztelése töredékek és bevonása megfelelően formázott docstrings.
követelmények :
- Python
Hozzászólás nem található