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

(define -ayalog '())

括弧に魅せられて道を外した名前のないプログラマ

Github PagesでSphinxのドキュメントを公開していく。

はい。Sphinx、正直reST覚えるのが嫌で触りたくなかったんですが、やむを得ない感じで触ることになったのと同時にGithub Pagesで公開しようって運びになったのでちょっとやってみた。

参考にしたのは以下のページ

工夫した箇所は2箇所くらいしかないし、参考リンクを読めばなんとかなる感じある。
あと、これを読んでいて、ディレクトリごちゃごちゃしてたから、気になってたけど実際かなりスマートに出来たので満足している。

要はドキュメントしか公開しないので、masterブランチにsphinxのsourceディレクトリとMakefileを入れて、git submodule*1をhtmlディレクトリって感じで用意してそこに出力してしまえば良いってだけ。
Makefileは少しいじる必要があって、BUILDDIRはhtmlディレクトリを指定しておく。それと別にもう一箇所、下のように書き直す必要がある。(元々は/buildって続いているんだけどbuildディレクトリを作られると邪魔なので削除)

html:
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/

まぁ色々書くより見たほうが早いと思うのでこっち見てください。

実際に公開しているGithub Pagesはこっち。

ちょっとまだSphinx突っ込んでビルドして公開しているだけなのでデフォルトのままだけど、とりあえずこの後これは修正されていく予定です。たぶん、きっと。

*1:gh-pagesブランチ