Python Sphinx Dokumentation

Kann jemand mir sagen, wie dieses Projekt zu Dokumentationszwecken verwendet werden können http://sphinx.pocoo.org Python Sphinx Dokumentation

ich erfolgreich es .Nach Installation auf meinem CentOS Maschine installiert haben Die Readme-Datei sagt Sphinx-quickstart und Wurzel für die Dokumentation laufen ist/home/tom/Docs

Wohin von hier, wie ich in/home/tom die Befehle verwenden können/Docs haben i Dateien __build conf.py index.rst make.bat Makefile _static _templates

Was kommt als nächstes? Wie Berichte für meine django Projekt zu erzeugen, die in/usr/my-Site befindet

Quelle

2010-11-30 Rajeev

Haben Sie irgendeinen Teil der Sphinx-Dokumentation gelesen? Welche Teile hast du gelesen? Kannst du ein spezielles Zitat aus der Sphinx-Dokumentation angeben, das dich verwirrt? –

Dies sind die drei Teile, 1.Defining Dokument Struktur 2.Addition Inhalt 3.Running the build.Bitte helfen Sie mir, diese 3 Teile zu verstehen – Rajeev

Auch, wie die Befehle wie ausführen: ref: 'rst-primer' – Rajeev

Nun, Sie gehen zu müssen Sie sich selbst etwas zu lesen bis zu tun. Da jedoch eine grundlegende Übersicht:

Sie würden in der Regel Sphinx-quickstart in einem Unterordner Ihres Projektes zur Dokumentation (z /usr/my-site/docs) ausgeführt werden.
Sie schreiben Sphinx-Dokumentation im reStructuredText (ersten) Format. Beginnen Sie mit der Bearbeitung der Datei index.rst, und Sie können später weitere Dateien hinzufügen. Wenn Sie fertig sind, verwenden Sie make html (oder make.bat html unter Windows), um die HTML-Dateien von Ihrer RST zu erstellen.

Quelle

2010-11-30 13:47:48

Danke, aber nach dem Aufbau der HTML, was wäre der nächste Schritt .. – Rajeev

@Rajeev: Welcher nächste Schritt? Der HTML ist deine Dokumentation. Sie können es in anderen Formaten erstellen, wenn Sie bevorzugen (http://sphinx.pocoo.org/builders.html), aber HTML ist praktisch. –

Antwort

Verwandte Themen