sphinxのカスタマイズ (1) - conf.py -

conf.py の役割

  • conf.py は、Sphinxでドキュメントをビルドする際の 設定記述ファイル

  • 外観、機能 を設定.

  • ドキュメント情報を記述 (プロジェクト名、著者、バージョン、言語など)のメタ情報を定義.

  • 出力形式ごとの調整 ( HTMLやLaTeX、EPUBなど出力形式ごとのカスタム設定 )

  • パス指定 ( css などの静的ファイルやテンプレートディレクトリを登録 )

  • ロールやディレクティブのカスタマイズ

  • .pyファイルで、条件分岐やモジュール読み込みなどpythonで柔軟な制御が可能.