Sphinx er et værktøj, der gør det nemt at oprette intelligente og smukke dokumentation for Python-projekter (eller andre dokumenter, bestående af flere reStructuredText kilder), skrevet af Georg Brandl. Projektet blev oprindeligt oprettet for at omsætte den nye Python dokumentation, men er nu blevet ryddet op i håb om at det vil være nyttigt for mange andre projekter.
Sphinx bruger reStructuredText som sit kodesprog, og mange af dens styrker er fra magten og ligefremhed af reStructuredText og parsing og oversætte suite, Docutils.
Selvom det stadig er under konstant udvikling, følgende funktioner er allerede til stede, fungerer fint og kan ses "i aktion" i Python docs:
& Nbsp; * Output formater: HTML (herunder Windows HTML Hjælp) og LaTeX, for PDF-versioner
& Nbsp; * Omfattende krydshenvisninger: semantisk markup og automatiske links til funktioner, klasser, ordliste vilkår og lignende stykker information
& Nbsp; * hierarkisk struktur: let definition af et dokument træ, med automatiske links til søskende, forældre og børn
& Nbsp; * Automatisk indeks: generelle indeks samt et modul indeks
& Nbsp; * Kode håndtering: automatisk fremhævning hjælp af Pygments highlighter
& Nbsp; * Forskellige udvidelser er tilgængelige, f.eks . til automatisk test af snippets og inddragelse af passende formateret docstrings
Krav :
- Python
Kommentarer ikke fundet