Columnディレクティブの紹介

概要

Sphinxをはじめよう の執筆時に Takayuki Shimizukawa が作成した Sphinx Column Directive Extension の使い方を紹介します。

Columnディレクティブとは Noteディレクティブにタイトルが付けられるようなイメージです。※admonitionディレクティブに似ていると思う方もいらっしゃるかもしれません

使い方

conf.pyへのコピー

gistのconf.py より適用させたい Sphinxプロジェクトconf.py にソースコードをコピーして下さい

custom.cssの作成

gistより custom.css をダウンロード、またはコピー&ペーストで作成し適用させたい Sphinxプロジェクト_static ディレクトリに配置して下さい。

reSTソースコードの作成とドキュメントのmake

gistのindex.txt がColumnディレクティブの記法となります。

まずは、そのままコピーして make html して見て下さい。下記のように出力されるでしょう。

../../_images/column.png