目的
Sphinxでドキュメントを書き、webで公開したい。ドキュメントは少しずつアップデートしていくため、その度にweb公開版を簡単にアップデートできるようにしておきたい。
そこで、ドキュメントをGitHubで公開するためのセッティングを行った。備忘録として記録しておく。
なお、GitHubのアカウントは既に取得しており、localマシンにはgitがインストールされているものとする。
GitHubでrepositoryを新規作成
GitHubのアカウントページにて、repositoryの新規作成を行う。
repository名を決めなくてはいけない。ここではnoteとしておく。
このとき、Settings-->pagesを開き、
Branchの設定を main + /docs に変えておく。
READMEは一応つけておく（チェックボタンがあるはず）。
localにrepositoryを作る
remoteからcloneすることで、localにrepositoryを作成する。
例えばGitHubのアカウント名がhogeであれば、
git clone https://github.com/hoge/note.git
とすると、現在いるディレクトリの下に note/ フォルダが作成される。
note/ フォルダに移り、docs/ フォルダを作成する。
docs/ フォルダに移り、.nojekyll という名の空ファイルを作成する。
note/ フォルダに戻り、
git add -A
git commit -m "初めてのコミット"
git push
とすると、localマシンの note/ フォルダの中身が remote に送られる。
Sphinx側の設定
以下の設定をしておく必要がある。
make.bat を以下のように変更。
set BUILDDIR = ../docs #フォルダ_buildより変更
%SPHINXBUILD% -b %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% #オプション-Mより変更
ドキュメント作成とアップロード
上記で環境は整った。
あとは、Sphinxドキュメントを更新するたびに
sources/ フォルダ内で
make html
としてドキュメント作成し、note/ フォルダ内で
git add -A
git commit -m "（更新内容の説明）"
git push
とすれば公開される。公開ドキュメントのリンクは
https://github.com/hoge/note/
となる。