--Installation des Python3-Systems
Erstellen Sie ein virtuelles Umgebungsverzeichnis für Sphinx. Der Verzeichnisname ist beliebig
$ mkdir sphinx
Wechseln Sie in das von Ihnen erstellte Verzeichnis und erstellen Sie eine virtuelle Umgebung Der Name der virtuellen Umgebung lautet hier sphinx-venv.
$ cd sphinx
# 「python3 -Sie können eine virtuelle Umgebung erstellen, indem Sie "Name der virtuellen Umgebung" verwenden.
$ python3 -m venv sphinx-venv
$ cd sphinx-venv
$ source bin/acitvate
$ pip install sphinx
Wenn Sie auf Sphinx-Schnellstart klicken, hören Sie eine schlürfende Nachricht und werden einige interaktiv gefragt. Wenn Sie dies vorerst nicht genau wissen, können Sie es wie folgt einstellen.
$ sphinx-quickstart
>Trennen Sie das Quellverzeichnis und das Erstellungsverzeichnis (y/ n） [n]:y
>Projektname: test-project
>Autorenname (n): test-author
>Projektfreigabe[]: 1.0.0
>Projektsprache[en]: ja
In meiner Ausführungsumgebung wurde ich wie oben auf Japanisch gefragt: Abhängig von der Umgebung werden Sie wie folgt auf Englisch gefragt.
$ sphinx-quickstart
> Separate source and build directories (y/N) [n]:y
> Project name: test-project
> Author name(s): test-author
> Project version []: 1.0.0
> Project language [en]: ja
Generieren Sie zunächst eine HTML-Datei im Standardzustand. Geben Sie zum Generieren einer HTML-Datei den folgenden Befehl ein, in dem sich das Makefile befindet
$ make html
Dadurch wird eine Datei mit dem Namen index.html im Erstellungsverzeichnis generiert. Bitte zeigen Sie es mit jedem Browser an.
In Sphinx, um Inhalte hinzuzufügen,
--Erstellen Sie eine neue Datei und
wird gebraucht.
Erstellen Sie eine Datei mit einem geeigneten Namen unter "Quelle". Hier lautet der Dateiname "test.rst".
Schreiben Sie den Inhalt entsprechend.
test.rst
===================
Geben Sie hier den Titel ein
===================
Setzen Sie eine große Überschrift
---------------
-Es ist eine Kugel
-Es ist eine Kugel
"Index.rst" unter "Quelle" ist die oberste Seite. Bearbeiten Sie diese Datei und registrieren Sie die zuvor erstellte "test.rst". Fügen Sie zum Bearbeiten denselben Namen wie den unten gezeigten Dateinamen hinzu.
index.zuerst (vor dem Bearbeiten)
.. toctree::
:maxdepth: 2
:caption: Contents:
index.zuerst (nach der Bearbeitung)
.. toctree::
:maxdepth: 2
:caption: Contents:
test
Wenn Sie nun "make html" erneut ausführen, wird die obere Seite angezeigt. "Titel hier einfügen" wird mit einem Link angezeigt. Klicken Sie auf diesen Link, um zu sehen, was in test.rst enthalten ist.
In Sphinx müssen Sie normalerweise das Dokument bearbeiten und dann "make html" eingeben, um den Browser neu zu laden. Dies ist mühsam. Wenn Sie das Dokument bearbeiten, wird automatisch eine HTML-Datei generiert, sodass es automatisch neu geladen wird.
$ pip install sphinx-autobuild
Geben Sie nach der Installation den folgenden Befehl in das Verzeichnis ein, in dem sich "Makefile" befindet.
# sphinx-autobuild [xxx.Verzeichnis mit rst] [Verzeichnis, in dem HTML-Dateien generiert werden]
#In diesem Eintrag wird es wie folgt sein
$ sphinx-autobuild source build
Anschließend wird der Server lokal gestartet. Wenn Sie also die URL (http : // localhost: 8080) in Ihrem Browser anzeigen, können Sie die erstellte HTML-Datei anzeigen.
Die folgende Beschreibung befindet sich am Ende von "conf.py" im Verzeichnis "source".
conf.py
html_theme = 'alabaster'
Sie können das Thema ändern, indem Sie 'alabaster' umschreiben. Beachten Sie, dass "Alabaster" das Standardthema ist.
Die folgenden Standardthemen sind in Sphix verfügbar.
Sie können auch ein Thema eines Drittanbieters festlegen. Wenn Sie beispielsweise ein Materialdesign-Thema festlegen möchten, installieren Sie das Thema wie folgt.
$ pip install sphinx-theme-material
Stellen Sie nach der Installation des Themas conf.py wie folgt ein. Nach dem Einstellen wurde das Thema in Materialdesign geändert.
conf.py
html_theme = 'material'
Recommended Posts