Ubuntu の Synaptic パッケージマネージャから、Sphinx をインストールする方法です。

Sphinx とは、ドキュメントを作成するためのツールです。指定の記法で記述したものを、HTML などに変換することができます。仕組みは wiki に似ていますね。プログラムのソースコードをそのまま貼ることができる(うまく整形してくれる)のが大きな特徴だと思います。

以前 Sphinx をいじったことがあるのですが、CodeIgniter のドキュメントが Sphinx 移行するので、本腰を入れようと思います。

Sphinx をインストールする場合、Ubuntu の Synaptic パッケージマネージャが便利です。「sphinx」で検索すると、様々なパッケージがヒットします。speech recognition(音声認識)なんてものもあったりします。今回とりあげるドキュメント生成ツールは、python-sphinx です。パッケージの説明でそれっぽいこと、sphinx が python 言語で記述されていること、をヒントに探しました。

パッケージを選択すると、たいていの場合、他のライブラリも必要ですが一緒にインストールしますか？といったメッセージが表示されます。それらも一緒にインストールします。これで sphinx のインストールは完了です。

プロジェクトを作るには、sphinx-quickinstall というコマンドを実行します。英語でいくつか聞かれますが、ほとんどは何も入力せずエンターでOKです。

html を生成するコマンドは、make html です。rest の構文ミスなどがあると、エラーメッセージとエラーが発生した行が表示されるので、それを参考にして修正します。

楽天で検索
【楽天ブックスならいつでも送料無料】エキスパートPythonプログラミング [ タレク・ジアデ ]
3888円
タレク・ジアデ 稲田直哉 アスキー・メディアワークス KADOKAWA発行年月：2010年05月 ページ数：415p サイズ：単行本 ISBN：97840486
楽天ブックス
Supported by 楽天ウェブサービス