Sphinx で自分用のドキュメントをまとめる

勉強していることや調べていることについて自分用に情報を整理してまとめておきたいと思うことがあり、Sphinx を使うことにしました。 これまではローカルで org-mode で書いたり、Google Docs 、Google sites を使ったり、ブログサービスで非公開のブログを作ったり、非公開の Wiki を作ったりといろいろ試してきましたが、機能、編集の容易さ、データの保守性などを考えるとどれも一長一短でなかなか難しいところです。

求める条件というか考えていたポイントとしては

  • ページ間でリンクを張れる
  • コンテンツと見た目の分離
  • 非公開設定ができる
  • データのバックアップが取れる
  • 長期にわたって利用できる

などがあります。 Google Sites あたりは一見よさそうだと思ったのですが、WYSIWYG は見た目の統一を図りそれを維持することが困難だと感じました。。

結局のところ Sphinx なら Pelican と同じように reST で書けるし、上記の条件はいずれもクリアしているだろうと判断してやってみることにします。

Sphinx のインストール、プロジェクトの作成などは Sphinx-Users.jp を見ながらやればそんなに難しいことはないかと思います。

テーマを変更

デフォルトのテーマだと少し色合いが暗いのでテーマを変更します。

こちらを見て書いてあるそのままインストール、conf.py の編集をすれば OK でした。

$ pip install sphinxjp.themes.basicstrap
# conf.py

# The encoding of source files.
source_encoding = 'utf-8-sig'

extensions += ['sphinxjp.themes.basicstrap']
html_theme = 'basicstrap'

日本語を使う場合は source_encoding = 'utf-8-sig' のところをコメントアウトされているのを解除して有効にする必要があります。