はじめに¶
Sphinxで作ったドキュメントを github.io で公開するメモです。 Sphinxのドキュメント作成方法は書きません。既にドキュメントのrstが作られている前提です。やっていることは Configuring a publishing source for GitHub Pages に書いてある事です。
概要¶
- githubにドキュメントをプッシュする
- githubの設定で docs を公開設定する
ディレクトリ構成¶
github_sphinx_example/
├── docs
└── docs_src
ディレクトリ説明¶
| ディレクトリ | 説明 |
|---|---|
| docs | github.ioで公開するHTMLソースを保存するディレクトリ |
| docs_src | Sphinxで作るドキュメントソースを保存するディレクトリ |
公開手順¶
githubにプッシュ¶
- docs_src 内でビルドした Sphinx HTMLドキュメント を docs へコピーまたは移動します。
$ cp -rp _build/html/* ../docs
- .nojekyll を作成します。
$ touch .nojekyll ../docs
警告
Githubでは標準で Jekyll を使います。Jekyllを使わないように .nojekyll を作成します。これを作成しないとgithub.ioでSphinxのスタイルシートなどをうまく読み込んでくれません。
- ディレクトリツリー例は以下のようになります。
github_sphinx_example
├── .gitignore
├── docs
│ ├── .nojekyll
│ (snip)
└── docs_src
- githubにプッシュします。
