読者です 読者をやめる 読者になる 読者になる

毎日Learning

学んだことを共有します

SphinxをWindows上で導入する手順

Sphinx

最近、Sphinxを社内で広めようと画策しています。

そこで、改めてWindows上で環境をつくる手順をまとめます。

基本的なインプットとしては、 Sphinx-Users.jp — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会 を参考にしています。

御題目ー。

1. Sphinxのインストール
2. blockdiagのインストール
3. Sphinxのテーマのインストール
4. プロジェクトをつくる

1. Sphinxのインストール

こちらについては、
Windowsへのインストール — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会
を見ていただくと、いっぱつで分かります。

2. blockdiagのインストール

ブロック図生成ツールのblockdiagをインストールします。
こちらをインストールしておくと、

.. blockdiag::
   :desctable:

   blockdiag {
      A -> B -> C;
      A [description = "browsers in each client"];
      B [description = "web server"];
      C [description = "database server"];
   }

って書くと良い感じのフロー図が書けたりします。

blockdiag の概要 — blockdiag 1.0 ドキュメント を見てインストールしてください。

その後、 sphinxcontrib-blockdiag — blockdiag 1.0 ドキュメント を見て、Sphinxを拡張していただくと、Sphinxでblockdiagが使えるようになります。

3. Sphinxのテーマのインストール

テーマの変更 — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会 を見ていただくと、Sphinxには、いろいろなテーマが用意されています。
こちらから、好きなテーマをインストールして、セットアップしていただくと、かっちょいー画面に簡単にできます。

今回は、 basicstrapbootswatch-amelia というテーマを選んでみました。

easy_install sphinxjp.themes.basicstrap

って実行して、 conf.py に設定を書くだけっすね。

4. プロジェクトをつくる

で、あとは、チュートリアルにしたがってプロジェクトをつくってみるって感じですね。

プロジェクトを作る — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会

基本的には、 Sphinx-Users.jp のサイトを見てもらえば、分かるはずっす。
今回は、どこをどう見ていくのか、をテーマに書いてみましたー。

以上っす。