タオルケット体操

サツバツいんたーねっとでゲームとかガジェットのレビューとかをします

Sphinxのテーマを作った

Sponsored link

スヒンクスのテーマを自作してみたけど、ちょっと作るだけなら以外に簡単だったよっていうはなし。

なおマークアップ力やセンスの欠如により周囲からは大不評の様子(かなしみ)。

まだ作り込みがイマイチだけど、リポジトリとかサンプルはここ

hachibeeDI / Sphinx-hachibee-theme

.confでのカスタマイズを可能にしたりとか、あとライセンスのところとかいい加減なので、もっとちゃんとしないといけない予感がありますね。

Sphinx is 何

Sphinxは、簡易マークアップを使って綺麗なドキュメントを簡単に作れて、htmlとかpdfとかepubに吐き出せるよっていうイカしたツール。

僕による社内での涙ぐましい布教活動のかいあって、最近うちのチームではドキュメントをSphinxでまとめだしている(えらい)。

こういう説明だと、なんか「敷居高そう」とか「黒い画面とか怖い……」みたいな印象を受けるかもしれないけど、導入も書くのも管理も簡単でまわりのお兄さん達もやっているし、使うとドキュメントを作るのが本当に気持ちよくなるんだ。エクセルやredmineのwikiに嫌気がさしたらやってみたらどうかな?

モチベーション

個人的に欲しい感じのテーマがあんまなくて、白ベースでマージン大きめでフォントがおっきくてCSSで日本語が指定されている、横幅指定のシンプルなテーマが欲しかったわけです。

ググってる時に見つけたbasicstrapとか、Flaskのアレとかはいい感じだったのだけれど、最近マークアップの書き方覚えたしせっかくだから作ろうと思った。

参考にしたもの

http://sphinx-users.jp/doc10/templating.html らへんと、あとは標準添付のテーマのソースコード

  

あとはテンプレートエンジンを少し触った経験があればなお良いです。

Sphinx標準のテンプレートエンジンであるJinja2はわかりやすい方だと思うので、後は上のあれとかを参考にして雰囲気を感じつつ適当にいじってればいい感じのものが出来上がるかと思います。最初のチュートリアルやドキュメントから感じるほどは敷居は高くないですよ。 なので、もっと色々な感じの野良テーマが増えてくれるといいなと思いました。

おわり