RTDしたい（sphinx_rtd_theme）

$ pip3 install sphinx_rtd_theme

sphinx_rtd_themeのtheme.confを眺めてみます。 これも元のテーマはbasicとなっていることが分かりました。

プロジェクトに追加したい

$ cd プロジェクト名
$ poetry add --group=docs sphinx
$ poetry add --group=docs sphinx_rtd_theme
$ poetry add --group=docs myst_parser
$ sphinx-quickstart docs
$ code docs/conf.py

poetryを使ってプロジェクトに追加する手順を書き出してみました。 ドキュメント関係のパッケージなので--group=docsに分類しています。

sphinx_rtd_themeはMySTと併用できます。 必要はパッケージ（sphinx / sphinx_rtd_theme / myst_parser）を追加、 docsにドキュメント用ディレクトリを作成、 docs/conf.pyを開いて、以下の設定を追記します。

テーマを使いたい

import sphinx_rtd_theme

extensions = [
    ...
    "sphinx_rtd_theme",
    "myst_parser",
    ...
]

html_theme = "sphinx_rtd_theme"

拡張（extensions）一覧にパッケージ名を追加します。 また、html_themeをパッケージ名に変更します。

テーマのオプションを設定する

html_theme_options = {
    "analytics_id": "G-XXXXXXXXXX",  #  Provided by Google in your dashboard
    "prev_next_buttons_location": "both",
    "style_external_links": True,
}

僕が必要だと思ったオプションを設定しました。 設定可能なオプションとその説明は公式ドキュメントのConfigurationを参照してください。

Google Analyticsしたい

html_theme_options = {
    "analytics_id": "G-xxxxxxxx",
    "analytics_anonymize_ip": False,
}

Read the Docsのドキュメントを参照すると、Configurationのページにオプションの設定方法が書かれていました。

注意

v3.0.0で analytics_idとanalytics_anonymize_ipの設定が廃止されました。 sphinxcontrib.googleanalyticsパッケージで代替できます。