Sphinx is een tool die het gemakkelijk maakt om intelligente en mooie documentatie voor Python projecten (of andere documenten die meerdere reStructuredText bronnen), geschreven door Georg Brandl creëren. Het project werd oorspronkelijk gemaakt om de nieuwe Python documentatie te vertalen, maar is inmiddels opgeruimd in de hoop dat het nuttig voor veel andere projecten zullen zijn.
Sphinx gebruikt reStructuredText als opmaaktaal, en veel van haar sterke punten komen van de kracht en directheid van reStructuredText en haar ontleden en vertalen suite, de Docutils.
Hoewel het nog constant in ontwikkeling, de volgende functies al aanwezig zijn, werken prima en kan gezien worden "in actie" in de Python-docs:
& Nbsp; * Output formaten: HTML (inclusief Windows HTML Help) en latex, voor printbare PDF-versies
& Nbsp; * Uitgebreide kruisverwijzingen: semantische markup en automatische koppelingen voor functies, klassen, termen in de woordenlijst en soortgelijke stukken informatie
& Nbsp; * hiërarchische structuur: eenvoudig definitie van een document boom, met automatische koppelingen naar broers en zussen, ouders en kinderen
& Nbsp; * Automatische indices: algemene index, evenals een module index
& Nbsp; * Code hanteren: automatische highlighting behulp van de Pygments markeerstift
& Nbsp; * Diverse uitbreidingen beschikbaar, bijv. . voor het automatisch testen van fragmenten en het opnemen van de juiste geformatteerd docstrings
Eisen
- Python
Reacties niet gevonden