python documentation sphynx

Quelqu'un peut-il me dire comment ce projet peut être utilisé pour la documentation afin http://sphinx.pocoo.org python documentation sphynx

Je l'ai installé avec succès sur ma machine CentOS .Après l'installation Le fichier Readme dit exécuter sphynx-QuickStart et la racine de la documentation est/home/tom/Docs

Où d'ici comment puis-je utiliser les commandes dans/home/tom/Docs i ont des fichiers __build conf.py index.rst make.bat Makefile _static _templates

Et ensuite? Comment générer des rapports pour mon projet de django qui se trouve dans/usr/mon site

Source

2010-11-30 Rajeev

Avez-vous lu une partie de la documentation de Sphinx? Quelles parties avez-vous lu? Pouvez-vous fournir un devis spécifique à partir de la documentation de Sphinx qui vous rend confus? –

Ce sont les trois parties, 1.Definition de la structure du document 2. Ajout du contenu 3. Exécution de la construction.Veuillez m'aider à comprendre ces 3 parties – Rajeev

Aussi comment exécuter les commandes comme: ref: 'rst-primer' – Rajeev

Eh bien, vous allez devoir faire un peu de lecture vous-même. Cependant, comme une vue d'ensemble:

Vous habituellement courir sphynx-QuickStart dans un sous-dossier de votre projet de documentation (par exemple /usr/my-site/docs).
Vous écrivez la documentation Sphinx au format reStructuredText (rst). Commencez par éditer le fichier index.rst, et vous pourrez ajouter plus de fichiers plus tard.
Lorsque vous avez terminé, utilisez make html (ou make.bat html sous Windows) pour générer les fichiers HTML à partir de votre RST.

Source

2010-11-30 13:47:48

Merci, mais après la construction du code HTML, quelle serait la prochaine étape .. – Rajeev

@Rajeev: Quelle étape suivante? Le HTML est votre documentation. Vous pouvez le construire dans d'autres formats si vous préférez (http://sphinx.pocoo.org/builders.html) mais HTML est pratique. –

python documentation sphynx

Répondre

Questions connexes