Dieses Sphinx-Theme wurde entwickelt, um Dokumentationsbenutzern auf Desktop- und Mobilgeräten ein großartiges Leseerlebnis zu bieten. Dieses Thema wird hauptsächlich in Read the Docs verwendet, kann aber mit jedem Sphinx-Projekt verwendet werden. Eine funktionierende Demo des Themes finden Sie in der Theme-Dokumentation
Dieses Theme wird auf PyPI verteilt und kann mit pip
installiert werden:
$ pip Sphinx-RTD-Theme installieren
Um das Theme in Ihrem Sphinx-Projekt zu verwenden, müssen Sie die html_theme
Einstellung Ihrer conf.py
Datei bearbeiten:
html_theme = "sphinx_rtd_theme"
Siehe auch:
Unterstützte Browser
Offiziell unterstützte und getestete Browser-/Betriebssystemkombinationen
Unterstützte Abhängigkeiten
Unterstützte Versionen von Python, Sphinx und anderen Abhängigkeiten.
Beispieldokumentation
Ein vollständiges Beispiel dieser Designausgabe mit aktivierten lokalisierten Zeichenfolgen.
Dieses Thema ist sowohl auf Seitenebene als auch auf globaler Ebene in hohem Maße anpassbar. Um alle möglichen Konfigurationsoptionen anzuzeigen, lesen Sie die Dokumentation zur Konfiguration des Themes.
Wenn Sie bei der Änderung oder Übersetzung des Themas mithelfen möchten, finden Sie weitere Informationen zum Mitwirken in unserem Beitragsleitfaden.