カテゴリー
ブログ

開発 備忘録 Sphinx でドキュメントを書く

Sphinxを昔から使いたかったのです。できるだけ早く。とは言いつつも、他にもやることがてんこ盛りでなかなかできていませんでした。が、先ほど、アップした通り、MacのpyenvでPython3の環境がだいぶ安定してきたこともあり、Sphinxをインストールして使うことができました。
かなり嬉しいです。
で、手順としては、pipが動いている場合には、とっても簡単で、

$ pip install sphinx

で、終わりです。本当にあっさり終わっちゃうので、拍子抜けしちゃうかもしれません。終わったら、念のため pip listあたりで確認をしておきましょう。サンプルのディレクトリでもデスクトップに作成し、

$ mkdir sphinx-first-test

$ cd Desktop/sphinx-first-test

そこから

$ sphinx-quickstart

とやると、プロジェクト名称などを聞かれ、Sphinxのファイル群が自動生成されます。あとは、Sphinxのユーザー会の皆さんのチュートリアルを参考にすすめていくと、ドキュメントを書くことができちゃいます。

http://sphinx-users.jp/gettingstarted/make_project.html
ちょっと今夜中なので、明日にでも整理します。
やった、うれしい!