6. ドキュメントをビルドする — Python 2.7ja1 documentation

### ナビゲーション

- 索引
- モジュール |
- 次へ |
- 前へ |
- Python 2.7ja1 documentation »
- Python のドキュメントの作成 »

# 6. ドキュメントをビルドする

ドキュメントをビルドするために使われるツールセットは Python で書かれているので、 Python 2.4 以上をインストールしておく必要があります。このツールセットは Sphinx と呼ばれていて、 Python ソースコードツリーには含まれておらず、別に管理されています。他にも、 Sphinx が利用しているマークアップの基礎を提供している docutils と、テンプレートエンジンの Jinja, オプションでコードハイライトをしたい場合は Pygments が必要です。

## 6.1. make を使う方法

Makefile が用意されているので、 Python と Subversion がインストールされている Unix 環境では、シンプルに次のコマンドを実行するだけです。

    make html

このコマンドは必要なツールセットを tools/ サブディレクトリ配下にチェックアウトし、　HTML 形式の出力ファイルをビルドします。出力された HTML ファイルを見るには、 “make” が完了してから、お好きなブラウザでトップページになる build/html/index.html ファイルを開いてください。

利用できる make の target は次のとおりです。

“make update” を実行すると、 tools/ 以下の Subversion チェックアウトを更新します。

## 6.2. make を使わない方法

Sphinx パッケージを、 PyPI からインストールするか、次のコマンドでチェックアウトしてください。

    svn co http://svn.python.org/projects/external/Sphinx-0.6.5/sphinx tools/sphinx

次に、 docutils を、 http://docutils.sf.net/ からインストールするか、次のコマンドでチェックアウトしてください。

    svn co http://svn.python.org/projects/external/docutils-0.6/docutils tools/docutils

Jinja2 も必要です。 PyPI からインストールするか、次のコマンドでチェックアウトしてください。

    svn co http://svn.python.org/projects/external/Jinja-2.3.1/jinja2 tools/jinja2

任意で、 Pygments をインストールすることもできます。 PyPI の http://pypi.python.org/pypi/Pygments からインストールするか、次のコマンドでチェックアウトしてください。

    svn co http://svn.python.org/projects/external/Pygments-1.3.1/pygments tools/pygments

出力ディレクトリ (例では build/ とします) を作成し、次のコマンドを実行します。

    python tools/sphinx-build.py -b<builder> . build/<出力ディレクトリ>

<builder> は、 html, text, latex, htmlhelp のどれかです。 (説明は上にある make の target を参照してください)

### ナビゲーション

- 索引
- モジュール |
- 次へ |
- 前へ |
- Python 2.7ja1 documentation »
- Python のドキュメントの作成 »