Sfinge è uno strumento che rende facile creare documentazione intelligente e bello per progetti Python (o altri documenti costituiti da più fonti reStructuredText), scritto da Georg Brandl. Il progetto è stato originariamente creato per tradurre la nuova documentazione Python, ma ora è stato ripulito, nella speranza che possa essere utile a molti altri progetti.
Sphinx utilizza reStructuredText come linguaggio di markup, e molti dei suoi punti di forza proviene dalla potenza e semplicità di reStructuredText e la sua analisi e traducendo privato, i Docutils.
Anche se è ancora in fase di costante sviluppo, le seguenti caratteristiche sono già presenti, funzionano bene e può essere visto "in azione" nella documentazione Python:
& Nbsp; * I formati di output: HTML (incluso Windows HTML Help) e LaTeX, per le versioni PDF stampabili
& Nbsp; * Ampi riferimenti incrociati: markup semantico e collegamenti automatici per le funzioni, classi, glossario e pezzi simili di informazioni
& Nbsp; * Struttura gerarchica: facile definizione di un albero del documento, con collegamenti automatici alle fratelli, genitori e figli
& Nbsp; * indici automatici: indice generale e un indice di modulo
& Nbsp; * gestione Codice: evidenziazione automatica con l'evidenziatore Pygments
& Nbsp; * Vari estensioni sono disponibili, ad esempio . per il test automatico dei frammenti e l'inclusione dei docstrings opportunamente formattati
Requisiti :
- Python
I commenti non trovato