Sphinx je nástroj, který umožňuje snadno vytvářet inteligentní a krásné dokumentace pro Python projekty (nebo jiné dokumenty sestávající z několika zdrojů reStructuredText), který napsal Georg Brandl. Projekt byl původně vytvořen přeložit nový Python dokumentaci, ale teď byl vyčištěn v naději, že bude užitečný pro mnoho dalších projektů.
Sphinx používá reStructuredText jako jeho značkovacího jazyka, a mnoho z jeho silných stránek pochází z moci a přímočarost o reStructuredText a jeho analýzu a překlady apartmá, v Docutils.
I když je stále v neustálém vývoji, tyto funkce jsou již přítomny, funguje dobře a je vidět "v akci" v Pythonu docs:
& Nbsp; * Výstupní formáty: HTML (včetně Windows nápovědě ve formátu HTML) a LaTeXu, pro tisková verze ve formátu PDF
& Nbsp; * Rozsáhlé křížové odkazy: sémantickým kódem a automatické odkazy na funkce, třídy, slovníček pojmů a podobné kousky informací
& Nbsp; * Hierarchická struktura: snadná definice stromu dokumentů, s automatickými odkazy na sourozence, rodiče a děti
& Nbsp; * Automatické indexy: index obecně, stejně jako index modul
& Nbsp; * manipulace Code: automatické zvýraznění pomocí Pygments zvýrazňovač
& Nbsp; * různé rozšíření jsou k dispozici, např. . pro automatické testování úryvků a začlenění vhodně formátovaných docstrings
Požadavky na :
- Python
Komentáře nebyl nalezen