[PYTHON] Wenn Sie möchten, dass das Thema Ihrer Sphinx-Dokumentation dasselbe ist

Einführung

Das Standardthema von Sphinx ist sehr stilvoll und etwas anderes.

Immerhin möchte ich das übliche verwenden.

Das Übliche

https://github.com/readthedocs/sphinx_rtd_theme

スクリーンショット 2019-11-14 13.12.54.png

Dies ist ein sehr häufig verwendeter Artikel.

Anscheinend ist dies ein Thema eines Drittanbieters, kein offizielles Thema, daher müssen Sie es separat installieren.

Verfahren

Mit einem Python-Pip, der auf das Verzeichnis angewendet wird, in dem Sie das Thema verwenden möchten

$ pip install sphinx-rtd-theme

Machen.

Dann in der Konfigurationsdatei conf.py

conf.py


extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.viewcode',
    'sphinx.ext.todo',
    'sphinx.ext.napoleon',
    'sphinx_rtd_theme'
]
html_theme = 'sphinx_rtd_theme'

Fügen Sie einfach Erweiterungen und html_theme hinzu.

Themenseite

Weil Sphinx-Themen eine Liste der verfügbaren Themen hat Es sieht gut aus, es zu benutzen.

Recommended Posts

Wenn Sie möchten, dass das Thema Ihrer Sphinx-Dokumentation dasselbe ist
Wenn Sie den Chrome-Treiber aktualisieren möchten.
Wenn Sie das Intervall der Achsenskala mit APLpy anpassen möchten
Wenn Sie es so verwenden möchten, wie es ist, wenn Sie es mit Lambda-Memo verwenden
Python Hinweis: Wenn Sie die Attribute eines Objekts kennen möchten
Wenn Sie den HTTP-Header des Testclients von Flask ändern möchten
Linux: Netplan-Konfigurationshandbuch, um zu sehen, wann Sie die IP-Adresse korrigieren möchten
Einstellungen, wenn Sie Python-Mecab mit Travis ausführen möchten
Wenn Sie mit dem Django REST-Framework filtern möchten
Wenn die Variable, die Sie in Matplotlib als hochgestellt verwenden möchten, aus zwei oder mehr Zeichen besteht
Wenn Sie in der for-Anweisung plt.save möchten
Die Programmiersprache, die Sie verwenden möchten
Wenn Sie ein C # -Beispiel schnell in eine andere Sprache wie VB übersetzen möchten
[Python] Wenn Sie Ihr eigenes Paket im oberen Verzeichnis importieren und verwenden möchten
[Django] Memorandum, wenn Sie asynchron kommunizieren möchten [Python3]
[AWS] Was tun, wenn Sie mit Lambda pfeifen möchten?
Ich wollte bestimmte Erweiterungen beim Erstellen der Sphinx-Dokumentation überspringen
Verwenden Sie aggdraw, wenn Sie mit Kissen schön zeichnen möchten
Wenn Sie die Anfangsdaten von Django mit Relationen registrieren möchten
Wenn Sie python2.x unter modernem Gentoo Linux verwenden möchten
Wenn Sie möchten, dass Ihre Kollegen dieselbe Sprache verwenden
Wenn Sie einen UNIX-Befehl in Python ausführen möchten
(Memo) Bis Sie nur den gewünschten Teil von einer bestimmten Webseite extrahieren, konvertieren Sie ihn in eine Sphinx-Seite und drucken Sie ihn als PDF
Wenn Sie mehrere Versionen derselben Python-Bibliothek verwenden möchten (virtuelle Umgebung mit venv)
[Unterprozess] Wenn Sie ein anderes Python-Programm in Python-Code ausführen möchten
Ich möchte die Ausführungszeit aufzeichnen und ein Protokoll führen.
[Linux] Ich möchte das Datum wissen, an dem sich der Benutzer angemeldet hat
Ich möchte Python GUI ausführen, wenn Raspberry Pi startet
[Python] Wenn Sie alle Variablen in einer anderen Datei verwenden möchten
Wenn Sie ein Objekt mit Anforderungen mithilfe der Flasche senden möchten
Was tun, wenn "Ich kann die Site nicht sehen !!!!"
Wenn Sie eine mehrdimensionale Liste nach mehreren Zeilen sortieren möchten
Memorandum Regulärer Ausdruck Wenn die Zeichenfolge mehrere Zeichen enthält, die Sie trennen möchten
Wercker Schritt zum Kompilieren der Sphinx-Dokumentation
Versuchen Sie, das Thema Pelican vorzustellen
Wichtige Operationen, die Sie wissen möchten
Wenn Sie einen Singleton in Python möchten, stellen Sie sich das Modul als Singleton vor
Ein Gist-Repository, das Sie verwenden können, wenn Sie es mit ansible ausprobieren möchten
Wenn Sie eine Spalte spaltenweise durch einen fehlenden Wert (NaN) ersetzen möchten
Bei der Einführung der Google Cloud Vision-API in Schienen habe ich die Dokumentation befolgt.
Wrapper, wenn Sie utf-8 + ansi color in der Windows-Konsole ausgeben möchten
Ist Qt nicht die stärkste Bibliothek für die einfache Ausgabe von SVG?
Bedeutet Memo, wenn versucht wird, maschinelles Lernen mit 50 Bildern durchzuführen
[Python3] Code, der verwendet werden kann, wenn Sie die Erweiterung eines Bildes sofort ändern möchten
Installieren Sie die Python-Bibliothek, wenn Sie kein Sudoer sind (oder wenn Sie nicht möchten, dass neue Benutzer Sudoer sind, es Ihnen aber nichts ausmacht, die Python-Bibliothek einzuschließen).