あのjsdo.itも使ったドキュメント作成ツール「Sphinx」


jsdo.itにはAPIがある。

あれのドキュメントを作ったのは、Pythonベースのドキュメント作成ツール「Sphinx」。

え?JavaScriptのサイトがPython?

まあそこは関係ない。

Sphinxは、簡単にドキュメントを作成できるツール。

まずはインストール。


easy_install -U Sphinx

あとは公式サイトのように、


sphinx_quickstart

とやれば対話が始まってファイルを作れる。

あとはindex.rstをvimかなにかで編集して、sphinx_buildコマンドを実行してbuild/index.htmlを開けばOK。

ドキュメントができている!

 

 

広告

コメントを残す

以下に詳細を記入するか、アイコンをクリックしてログインしてください。

WordPress.com ロゴ

WordPress.com アカウントを使ってコメントしています。 ログアウト / 変更 )

Twitter 画像

Twitter アカウントを使ってコメントしています。 ログアウト / 変更 )

Facebook の写真

Facebook アカウントを使ってコメントしています。 ログアウト / 変更 )

Google+ フォト

Google+ アカウントを使ってコメントしています。 ログアウト / 変更 )

%s と連携中