sphinx_rtd_theme

ドキュメントの Sphinx テーマを読む

この Sphinx テーマは、デスクトップとモバイル デバイスの両方でドキュメント ユーザーに優れた閲覧エクスペリエンスを提供するように設計されています。このテーマは主に Read the Docs で使用されますが、どの Sphinx プロジェクトでも使用できます。テーマの動作デモはテーマのドキュメントにあります。

インストール

このテーマは PyPI で配布されており、 pipでインストールできます。

 $ pip install sphinx-rtd-theme

Sphinx プロジェクトでテーマを使用するには、 conf.pyファイルのhtml_theme設定を編集する必要があります。

 html_theme = "スフィンクス_rtd_テーマ"

以下も参照してください。

• サポートされているブラウザ

• 公式にサポートおよびテストされたブラウザとオペレーティング システムの組み合わせ

• サポートされている依存関係

• Python、Sphinx、およびその他の依存関係のサポートされているバージョン。

• ドキュメントの例

• ローカライズされた文字列を有効にした、このテーマの出力の完全な例。

構成

このテーマは、ページ レベルとグローバル レベルの両方で高度にカスタマイズ可能です。可能なすべての構成オプションを確認するには、テーマの構成に関するドキュメントを参照してください。

貢献する

テーマの変更または翻訳を支援したい場合は、貢献ガイドで貢献に関する詳細情報をご覧ください。