読者です 読者をやめる 読者になる 読者になる

github pages に Sphinx で生成したドキュメントを公開する。

Github PagesSphinxで生成したドキュメントを公開するほうほうです。

Github Pages では各リポジトリごとにプロジェクトページを作成することができます。
各プロジェクトごとにページを作成することでマニュアルなどの公開が便利にできます。

Sphinx で生成したドキュメントをそのまま公開すると、スタイルシートなど静的ファイルへのリンクが切れてしまいます。
静的ファイルは、ルートからのパスを想定しているためです。

html 生成時にリンクを修正してくれるプラグインが公開されています。
sphinxtogithub を利用すると、 Github Pages 用のリンクに修正してくれます。

利用方法
1. sphinxtogithub をインストールする。

$ easy_install -ZU sphinxtogithub

2. conf.py で、プラグインを有効にする。

extensions = ['sphinxtogithub']

3. make html でプロジェクトを生成しなおす。

以上の手順だけで簡単に Github Pages 対応ができます。