Sphinx 拡張 : スライドの作成¶

sphinx は他の拡張ライブラリをインストールすると多様な表現が可能になります. このページでは, 数ある sphinx 拡張ライブラリの中から sphinxjp.themes.s6 を紹介します. この拡張を使用すると, rst 形式で HTML を利用したスライドが簡単に作成できます.

導入方法¶

ここでは, 何も無い状態から上記の環境を構築していく方法をメモします.

まずは必要なライブラリを導入しましょう. 今回私の環境では pip コマンドからすべてのライブラリを導入しています.

$ pip install sphinx
$ pip install sphinxjp.themecore
$ pip install sphinxjp.themes.s6

私が参考にしたサイトでは, 2行目の記述がありませんでしたが, 私の環境ではこれがないと HTML にビルドする際にエラーが起きました.
参考サイト
- http://d.hatena.ne.jp/juno_c/20111130/1322661894
- http://shuzo-kino.hateblo.jp/entry/2013/10/02/213949

基本的には以下のような使用方法でスライドが作成できます.

これは通常の sphinx の使用方法と変わりません. 端末上で, 任意の作業ディレクトリに移動して, 下記のコマンドを入力します.

$ sphinx-quickstart

これを入力すると色々聞かれますが, 基本的に

のみを記述すれば問題ないです.

上記の作業が完成すると, プロジェクト名のディレクトリが作成されます. このディレクトリの直下にある conf.py の以下の部分を書き換えます.

# line 26
extensions = ['sphinxjp.themecore']
# line 100
html_theme = 's6'

続いて同じディレクトリ内にある index.rst を編集します. このファイルがスライドの本体に当たります.

ここでは, 一旦適当なファイルを作成してみます.

表紙タイトル
================

topic1
----------------

- hoge
- foo

topic2
----------------

- hogehoge
- foofoo

ここまでの作業が終了したら, rst ファイルを html に変換します.

$ make clean && make html && open _build/html/index.html

上記のコマンドを打ち込むことでファイルがブラウザ上で確認できると思います.