Ich habe Sphinx in der Umgebung von Mac OS X 10.8.5 + Python 2.7.5 installiert. Sie müssen mit dem Internet verbunden sein.
Laden Sie zunächst ez_setup.py herunter und installieren Sie es. Unter Mac OS X lautet der Befehl get curl anstelle von wget.
$ curl https：//bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py -o ez_setup.py
$ python ez_setup.py
Wenn die Installation fehlschlägt, versuchen Sie, sie mit Administratorrechten auszuführen.
$ sudo python ez_setup.py
Installieren Sie Sphinx mit der installierten easy_install. Diesmal wurde 1.1.3 ausgewählt. (Die neueste ist 1.2.)
$ easy_install sphinx
Searching for sphinx
Best match： Sphinx 1.1.3
...
Erstellen Sie ein Projektverzeichnis (hier "Sphinx") und verschieben Sie das aktuelle.
$ mkdir sphinx
$ cd sphinx/
Generieren Sie ein Sphinx-Projekt mit Sphinx-Schnellstart. Da dies eine "Testversion" ist, beantwortete ich die Fragen nach dem Ausführen des Sphinx-Schnellstarts mit fast den Anfangswerten (drücken Sie die [Eingabetaste]).
$ sphinx-quickstart
$ ls
Makefile build/ make.bat source/
"Index.rst" im Quellverzeichnis ist die Datei reStructuredText.
$ ls source/
_static/ _templates/ conf.py index.rst
Erstellen Sie HTML aus einer Datei im Quellverzeichnis.
$ make html
$ ls build/html/
_sources/ genindex.html objects.inv searchindex.js
_static/ index.html search.html
Starten Sie den WWW-Browser (in diesem Fall Safari) und überprüfen Sie den erstellten HTML-Code.
$ open /Applications/Safari.app build/html/index.html
Recommended Posts