[PYTHON] Memo über Sphinx Teil 1 (Erstellen eines Projekts)

Sphinx ist ein in Python geschriebenes Dokumentationswerkzeug. Im Gegensatz zu Word können Sie Dokumente wie ein Programm schreiben. Seite der Sphinx Japan Users Association

Schritt Hinweise zum Erstellen und Erstellen eines Projekts.

Umgebung

OS:Mac OS X 10.9.5 Python:Ver.2.7.7

Wie erstelle ich ein Projekt?

$ sphinx-quickstart

• Grundsätzlich ist [Enter] in Ordnung, aber Sie müssen die folgenden Fragen eingeben.
• Projektname
• Autorenname
• Ausführung
• Detaillierte Erklärung des Sphinx-Schnellstarts

・ ・ ・
#Projektname und Autorenname.
The project name will occur in several places in the built documentation.
> Project name: #Projekttitel
> Author name(s): #Autorenname
・ ・ ・
#Projektversion
Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1.  If you don't need this dual structure,
just set both to the same value.
> Project version: 2014.09.27
> Project release [2010.09.27]:
・ ・ ・

• Nach Abschluss werden die folgenden Dateien erstellt
• Makefile
• index.rst
• conf.py
• make.bat
• _static/
• _build/
• _templates/

Wie zu bauen

Ausgabe in HTML

$ make html

HTML wird im Ordner _build / html generiert. Öffnen Sie ** index.html ** und Sie haben ein Dokument.

Ausgabe mit epub

$ make epub

Wird im Ordner _build / epub generiert.

Ausgabe im Latexformat

$ make latex

Wird im Ordner _build / latex generiert.