Dieser Artikel handelt vom Python-Modul "Sphinx"
--Wie installiert man
Ich werde darüber erklären.
Auf der folgenden Website finden Sie detaillierte Erklärungen zu Sphinx. Sphinx Japan User Association
Dieses Mal habe ich eine virtuelle Umgebung erstellt und installiert. Dieser Schritt ist nur erforderlich, wenn Sie Ihr eigenes virtuelles Umgebungsmodul verwenden oder sich speziell damit befassen.
Erstellen Sie eine virtuelle Umgebung an einem beliebigen Ort und starten Sie sie.
$ mkdir Sphinx
$ virtualenv --no-site-packages Sphinx
$ cd Sphinx
$ source bin/activate
(Sphinx)$
Installieren Sie dann das Sphinx-Modul mit pip.
(Sphinx)$ pip install sphinx
Zu diesem Zeitpunkt ist die Installation von Sphinx abgeschlossen.
Erstellen Sie einen Ordner für das Projekt an einem beliebigen Ort und Führen Sie den Befehl sphinx-quickstart darin aus.
(Sphinx)$ mkdir MyProject
(Sphinx)$ cd MyProject
(Sphinx)$ sphinx-quickstart
Wenn ich den Befehl ausführe, werde ich nach allen Optionen gefragt. Wenn ich jedoch die grundlegende Eingabetaste drücke, ist dies in Ordnung.
Es müssen nur drei Elemente eingegeben werden. Geben Sie sie daher entsprechend ein. Es gibt eine Einstellung für die Objektsprache. Wenn Sie jedoch Japanisch verwenden möchten, geben Sie ja ein, um fortzufahren.
Nach Abschluss der Projekterstellung
(Sphinx)$ make html
Generiert HTML in _build / html im aktuellen Verzeichnis. Wenn Sie _build / html / index.html in Ihrem Browser anzeigen, können Sie sehen, dass das Dokument generiert wurde.
Einstellungen zum Themawechsel befinden sich im Projektordner (diesmal MyProject). Mach es in conf.py.
conf.py
html_theme = 'default'
Sie können das Standardthema ändern, indem Sie den Zeichenfolgenteil von ändern.
Vergessen Sie nicht nach der Änderung
(Sphinx)$ make html
Lass es uns tun.
Es gibt neun Standardthemen wie folgt.
Die Standard-Themenbilder, die verwendet werden können, werden auf der folgenden Website veröffentlicht. Standard-Themensammlung
Mit Sphinx können Sie auch externe Themen verwenden. Dieses Mal werde ich anhand des Bootswatch-Themas erklären. Bootswatch
・ Installation der Bootswatch Arbeiten Sie weiter in der virtuellen Umgebung.
(Sphinx)$ pip install shpinx_bootstrap_theme
-Stellen Sie das Bootswatch-Thema auf Sphinx Dies wird auch in conf.py im Projektordner festgelegt.
Importieren Sie zunächst das Modul in die erste Zeile von conf.py. Bitte achten Sie darauf, keinen Kommentar abzugeben.
conf.py
import sphinx_bootstrap_theme
Fahren Sie mit dem Verzeichnis fort, in dem das Thema gespeichert ist Und legen Sie den Themennamen fest.
conf.py
html_theme = 'bootstrap'
html_theme_path = ['../lib/python3.5/site-packages/sphinx_bootstrap_theme']
~~ In der offiziellen Bootwatch-Dokumentation wurde angegeben, dass eine dedizierte Funktion zum Festlegen von html_theme_path vorbereitet wurde. Da jedoch in meiner Umgebung ein Fehler aufgetreten ist, wird dieser als relativer Pfad zum Modul ~~ beschrieben
** Nachtrag: von yuntas hervorgehoben ** Es scheint gelöst zu werden, indem das Folgende in conf.py auskommentiert wird.
conf.py
import os
import sys
sys.path.insert(0, os.path.abspath('.'))
...
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
Geben Sie dann direkt unter dem obigen Code an, welches Bootwatch-Design verwendet werden soll. Klicken Sie hier für die Arten von Themen. Bootswatch
conf.py
html_theme_options = {'bootswatch_theme': "cosmo"}
Vergiss das nicht nach der Änderung
(Sphinx)$ make html
Lass es uns tun.
Damit ist die Einstellung des externen Themas abgeschlossen.
Recommended Posts