sphinx-me

sfinge-me è uno strumento di Python che creerà una shell documentazione Sfinge per il progetto e includere il file README come l'indice della documentazione. & Nbsp; Gestisce l'estrazione dei metadati necessari come ad esempio il nome del progetto, l'autore e la versione dal progetto per l'utilizzo in tuoi documenti Sfinge.
Una volta che si utilizza sfinge-me per costruire i tuoi documenti Sfinge, è quindi possibile aggiungere il progetto per il sito leggere la documentazione e hanno README del progetto ospitato con un bel tema di documentazione Sfinge.
Nota: Il file README deve essere in un formato compatibile reStructuredText.
Installazione
Il modo più semplice per installare sfinge-me è direttamente da PyPI utilizzando pip o setuptools eseguendo il rispettivo comando di seguito:
Pip installare -U sfinge-me
oppure:
easy_install -U sfinge-me
In caso contrario, è possibile scaricare sfinge-me e installarla direttamente dalla fonte:
python setup.py install
Esecuzione
sfinge-me sarà installato come script a livello di sistema che può essere eseguito da linea di comando, mentre nella directory principale del progetto:
sfinge-me
Quando viene eseguito nella directory del progetto, si creerà una directory docs con due file, il modulo conf.py Sfinge, e un file index.rst che includerà README del progetto.
Il modulo conf.py chiama una funzione di setup da sfinge me-che imposta il minimo impostazioni necessarie per i vostri documenti Sphinx.
- Progetto - viene utilizzato il nome della directory del progetto.
- Versione - recuperati dalla versione arg dello script setup.py, o un attributo __version__ del vostro pacchetto.
- Copyright - recuperate dall'autore arg dello script setup.py, o un attributo __author__ del pacchetto

Requisiti

• . Python