Sphinx ay isang tool na ginagawang madali upang lumikha ng intelligent na at maganda papeles para sa Python mga proyekto (o iba pang mga dokumento na binubuo ng maramihang mga pinagmumulan ng reStructuredText), isinulat ni Georg Brandl. Ang proyekto ay orihinal na nilikha upang i-translate ang mga bagong dokumentasyon Python, ngunit Nalinis na ngayon sa pag-asang ito ay magiging kapaki-pakinabang sa maraming iba pang mga proyekto.
Sphinx ay gumagamit ng reStructuredText bilang markup language nito, at marami sa mga lakas nito ay nagmumula sa kapangyarihan at katapatan ng reStructuredText at pag-parse nito at nagta-translate suite, ang Docutils.
Kahit na ito ay pa rin sa ilalim ng pare-pareho ang pag-unlad, ang mga sumusunod na tampok ay mayroon na, gumagana fine at maaaring makita "sa aksyon" sa Python doc:
& Nbsp; * format ng Output: HTML (kabilang ang Windows HTML Help) at LaTeX, para sa napi-print na bersyon PDF
& Nbsp; * malawak na cross-sanggunian: semantiko markup at awtomatikong mga link para sa mga pag-andar, mga klase, mga tuntunin glossary at mga katulad na piraso ng impormasyon
& Nbsp; * hierarchical istraktura: madaling kahulugan ng isang dokumento tree, na may awtomatikong mga link sa mga kapatid, magulang at mga anak
& Nbsp; * Awtomatikong pag-index: pangkalahatang index pati na rin ng module index
& Nbsp; * handling Code: awtomatikong pag-highlight gamit ang Pygments Highlighter
& Nbsp; * Iba't ibang mga extension ay magagamit, hal . para sa awtomatikong pagsubok ng mga snippet at pagsasama ng angkop na na-format na docstrings
Mga Kinakailangan :
- Python
Mga Komento hindi natagpuan