基本設定したい(conf.py
)
Sphinxドキュメントの全体設定はconf.py
(またはsource/conf.py
)で管理します。
sphinx-quickstart
したあとは、まず、基本設定しておきます。
注釈
Sphinxは活発に開発されています。 設定に必要な項目も見直されていたりするので、 昔のバージョンで作り始めたドキュメントがある場合は、 いちど設定を見直してみるといいかもしれません。
実際に、僕もv5系で新規にドキュメントを作成したら
はじめに生成される設定ファイル(conf.py
とMakefile
)の項目が
かなりすっきりしていて驚きました。
プロジェクトの情報
1# -- Project information -----------------------------------------------------
2# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
3
4project = 'KumaROOT'
5author = 'Shota TAKAHASHI'
6copyright = '2015 - 2022, Shota TAKAHASHI'
7version = '0.5.0'
8release = '0.5.0'