Sphinx is 'n instrument wat maak dit maklik intelligente en pragtige dokumentasie vir Python projekte (of ander dokumente wat bestaan uit verskeie reStructuredText bronne), geskryf deur Georg Brandl te skep. Die projek is oorspronklik geskep om die nuwe Python dokumentasie te vertaal, maar nou is skoongemaak in die hoop dat dit nuttig om baie ander projekte sal wees.
Sphinx gebruik reStructuredText as sy opmaak taal, en baie van sy sterk punte uit die krag en opregtheid van reStructuredText en sy ontleding en vertaling suite, die Docutils.
Hoewel dit nog onder konstante ontwikkeling, die volgende kenmerke is reeds teenwoordig, werk fyn en kan gesien word "in aksie" in die Python docs:
& Nbsp; * uitvoer formate: HTML (insluitend Windows HTML Help) en LaTeX vir afdruk PDF-weergawes
& Nbsp; * Uitgebreide kruis-verwysings: semantiese opmaak en outomatiese skakels vir funksies, klasse, Glossary terme en soortgelyke stukke van inligting
& Nbsp; * Hiërargiese struktuur: maklike definisie van 'n dokument boom met outomatiese skakels na broers en susters, ouers en kinders
& Nbsp; * Outomatiese indekse: algemene indeks sowel as 'n module indeks
& Nbsp; * Kode hantering: outomatiese verligting met behulp van die Pygments highlighter
& Nbsp; * Verskeie uitbreidings is beskikbaar, bv . vir 'n outomatiese toets van brokkies en insluiting van toepaslik geformateer docstrings
Vereistes :
- Python
Kommentaar nie gevind