Sphinxのドキュメントのテーマをいつものにしたいとき

はじめに

Sphinxのデフォルトのテーマは、ものすごくスタイリッシュでなんか違うんだよな　になります。

やはり、いつものアレを使いたいですね。

いつものアレ

やけに使用頻度の高いコレです。

どうやら、これは公式のテーマではなくサードパーティ製のテーマのため、別途インストールする必要があります。

手順

テーマを使用したいディレクトリに適用されたPythonのpipで

$ pip install sphinx-rtd-theme

をします。

その後、設定ファイルの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'

extensionsとhtml_themeを追記すればよいです。

テーマサイト

sphinx-themesに、使用できるテーマ一覧があるため、
活用するとよさそうです。