Sphinxを使ってみる - ponkotuyの日記

前の奴とは別件になるが、Pythonの標準ドキュメントで使われているreStructuredTextと呼ばれる軽量マークアップ言語があるらしい。これは試してみなくてはなるまい、という訳で色々調べてみた。

調べてみた結果、Sphinxを使えば良い？らしい。早速弄ってみた。

簡単な作り方であるが、先ずsphinx-quickstartコマンドでディレクトリとファイル一式を作成する。Makefile作られるし、あとは適当にファイル追加していけばOK…なんじゃないかな。

というのも、実はコレ、高度なドキュメント生成ツールなのである。プログラムに付き物のドキュメントを、HTML等ひっくるめて、1つのソースから一括生成できるという、かなり大掛りなシステムである。

私の目的はあくまで軽量マークアップ言語なので、高度なドキュメント検索サイトを作ってもしょうがないのである。という訳でSphinxがどんなもんか理解したところで、止めておく。最近なんかこういうの多いなー…。