Sphinx プロジェクトの新規作成

本プロジェクトの作成方法を備忘録としてまとめる。

事前設定

ライブラリのインストール

pip install sphinx

プロジェクトの新規作成

sphinx-quickstart
  • 下記設定のみ注意

    • Separate source and build directories (y/n) [n]: y

  • 設定が終わると、実行したファイル内に新規プロジェクトが作成される。

html 化

make html
  • build/html/index.html から、作成したページを参照できる