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

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

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

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

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

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

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

テーマを変更

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

more ...

reST で blog を書く理由

今回、このドメインで blog を再開することを決めた際に考えていたこと(今も考えていること)を書いてみます。

動的生成と静的生成

まず、個人で書く blog のような一度書いたエントリはその後変更されることがあまりないようなタイプのサイトで、(キャッシュの仕組みはあるのでしょうが)アクセスがあるたびに毎回動的に HTML を生成するのはナンセンスというか、コンピューター資源の無駄遣いというか、個人的にはあまりしっくりこないなぁと感じていて、やるなら静的生成がいいと考えていました。

最近のトレンドというか傾向を参考にしたならば、独自ドメインで blog をやるなら WordPress が順当な選択肢となっているという認識を持っていますが、WordPress は動的生成だし、以前に使用していたときに本体やプラグインのアップデートがけっこう頻繁にあって煩わしかった記憶もあるし、"WordPress" のスペルを強制する関数が本体に含まれていること を知って以来、[1] あまり好ましい印象を持っておらず、積極的に避けたいと思っていました。 (まぁ猫も杓子も WordPress という流れに逆らいたい、というマイナー志向の顕れという側面も否定できません 笑)

blog の前に Sphinx

blog エンジンとして Pelican の前には Nikola を検討していました。どちらも Python で書かれているので何かいじる際に都合がいいというのが主な理由です ...

more ...