Follow

Il logo di Sphinx.

Mi apprestavo a scrivere la documentazione per PyBackup (che attualmente è in fase di manutenzione, rifinizione, etc etc) ed ho trovato molto comodo il tool Sphinx (utilizzato addirittura per la documentazione ufficiale del progetto Python).

Sphinx però non è presente nei repository di Ubuntu Hardy e l’istallazione da sorgenti, sebbene automatizzata, mi aveva dato problemi.

Girando per la rete ho visto che Sphinx è presente però nei repository di Intrepid Ibex. Allora ho scaricato il deb di sphinx e la sua dipendenza e le ho installate senza problemi.

Sphinx permette di creare documentazione HTML e LaTex in maniera veramente molto semplice, basta ricordare quelle due-tre regole di sintassi per fare di tutto. Basta scrivere dei file .rst che poi elaborerete con sphinx-build.

Per maggiori informazioni vi rimando al sito ufficiale dove ci sono esempi e il file di documentazione che potete consultare per capire come usare Sphinx nei vostri progetti.

Inoltre ci tengo a precisare che Vim è in grado di evidenziare la sintassi dei sorgenti dei file .rst a differenza di gEdit e degli altri editor che ho provato. 🙂