Wie funktioniert Python Website seine Online-Dokumentation generieren?

Question

  

Erstellt mit Sphinx 0.6.5.

ich weiß, Python Dokumentation verwendet reStructuredText, aber es hat verschiedene Abschnitte wie http://docs.python.org/whatsnew/2.6.html und http://docs.python.org/tutorial/index.html.

Wie tun Sie dies in reStructuredText? Haben Sie rst2html in einem Bündel von Verzeichnissen laufen, seine Struktur zu halten?

Ich weiß, dass es verwendet Sphinx (nicht rst2html direkt wie gesagt von Thomas Wouters in einer Antwort ), aber, wie Sie Ihre erste Struktur mit Quellcodedateien in einem Repository organisieren sollten, so dass Sie eine vollständige geblasenen automatisierten doc Website?

Answer 1

Die Dokumentation Python verwendet reST für seine Markup , aber es erzeugt die HTML sphinx verwenden, nicht direkt rst2html. Das sphinx Werkzeug ist das, was alle einzelnen .rst Dateien in mehrere .html Dateien umwandelt. Um zu sehen, wie die Python-Dokumentation erzeugt werden, finden Sie unter http://svn.python.org / projects / python / trunk / Doc / Makefile

Answer 2

fand ich die sampledoc Tutorial auf der Website matplotlib sehr nützlich mit Sphinx zu beginnen.

Answer 3

Hier ist wie Python-Dokumentation zu bauen genau.