Sphinx と Twitter Bootstrap を組み合わせる

ちょっとしたドキュメントを Sphinx で書くのがよさそうだと思ったけどデフォルトのテーマがあまりかっこよくないんですよね。そこで今風な Twitter Bootstrap を組み合わせる方法を検索したら、ありました。

https://github.com/ryan-roemer/sphinx-bootstrap-theme

使い方はとても簡単。

git clone して bootstrap ディレクトリを _themes に置く

% git clone https://github.com/ryan-roemer/sphinx-bootstrap-theme.git
% mkdir _themes
% mv sphinx-bootstrap-theme/bootstrap _themes

conf.py に書く。(html_theme は既存の設定があるので上書き)

sys.path.append(os.path.abspath('_themes'))
html_theme_path = ['_themes']
html_theme = 'bootstrap'
html_short_title = "Hello Sphinx"

ビルド

make html

できた。

screenshot