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