ドキュメンテーションツール「sphinx」を導入してみる

sphinxは、ドキュメンテーションツールの一つ。rstやmarkdownなどの記法を用いることで、htmlをゴリゴリ書くことなくドキュメントを作成することが可能。

 

sphinxのインストール

依存関係を導入

sudo apt-get install python-pip
sudo apt-get install python-setuptools
sudo apt-get install pandoc

 

pipを用いて本体の導入

pip install Sphinx

 

sphinxは、作成したテキストファイルをビルドすることでドキュメントの生成を行う。イメージとしてはTeXに近い。ドキュメントを作るには、まずクイックスタートを実行し、プロジェクトを作成する。1つのプロジェクトは1つのフォルダに入れておいたほうが良さそう。

sphinx-quickstart

 

クイックスタートした後、プロジェクトフォルダ直下でビルドすればOK。

make html

こんな感じ。ビルド先にhtmlが生成される。