Sphinx er et verktøy som gjør det enkelt å lage intelligent og vakker dokumentasjon for Python prosjekter (eller andre dokumenter som består av flere reStructuredText kilder), som er skrevet av Georg Brandl. Prosjektet ble opprinnelig opprettet for å oversette den nye Python dokumentasjon, men har nå blitt ryddet opp i håp om at det vil være nyttig for mange andre prosjekter.
Sphinx bruker reStructuredText som sin markup language, og mange av sine sterke sider kommer fra kraften og oppriktighet av reStructuredText og dens parsing og sette suite, Docutils.
Selv om det fortsatt er under konstant utvikling, er følgende funksjoner er allerede til stede, fungerer fint og kan bli sett "in action" i Python docs:
& Nbsp; * Output formater: HTML (inkludert Windows HTML-hjelp) og LaTeX, for utskriftsvennlig PDF-versjoner
& Nbsp; * Omfattende kryssreferanser: semantisk markup og automatiske koblinger for funksjoner, klasser, ordliste vilkår og lignende biter av informasjon
& Nbsp; * hierarkisk struktur: enkel definisjon av et dokument treet, med automatiske linker til søsken, foreldre og barn
& Nbsp; * Automatisk indekser: generelle indeksen samt en modul index
& Nbsp; * Kode håndtering: automatisk utheving bruker Pygments merkepenn
& Nbsp; * Ulike utvidelser er tilgjengelig, f.eks . for automatisk testing av tekstbiter og inkludering av riktig formatert docstrings
Krav :
- Python
Kommentarer ikke funnet