Sphinx är ett verktyg som gör det enkelt att skapa intelligenta och vackra dokumentation för Python-projekt (eller andra dokument bestående av flera ReStructuredText källor), skriven av Georg Brandl. Projektet skapades ursprungligen för att översätta den nya Python dokumentationen, men nu har sanerats i hopp om att det kommer att vara till nytta för många andra projekt.
Sphinx använder ReStructuredText som sitt märkspråk, och många av dess styrkor kommer från makten och rättframhet i ReStructuredText och dess tolkning och översättning svit, de Docutils.
Även om det fortfarande är under ständig utveckling, följande funktioner redan finns, fungerar bra och kan ses "in action" i Python docs:
& Nbsp; * Output format: HTML (inklusive Windows HTML-hjälp) och LaTeX, för utskrivbara PDF-versioner
& Nbsp; * Omfattande hänvisningar: semantisk uppmärkning och automatiska länkar för funktioner, klasser, ordlista termer och liknande bitar av information
& Nbsp; * Hierarkisk struktur: enkel definition av ett dokument träd, med automatiska länkar till syskon, föräldrar och barn
& Nbsp; * Automatiska index: generalindex samt en modul index
& Nbsp; * Kod hantering: automatisk markering med hjälp av Pygments highlighter
& Nbsp; * Olika tillägg är tillgängliga, t.ex. . för automatisk testning av snuttar och inkludering av lämpligt formaterade docstrings
Krav :
- Python
Kommentarer hittades inte