#
2 ディレクトリ構造

標準 Python ドキュメントのソース配布物には、数多くのディレクトリが 入っています。サードパーティ製のドキュメントは、このディレクトリ構造下や 似たディレクトリ構造下におく必要はありませんが、Python ドキュメント作成 ツールを利用して新たなドキュメントを開発する際に、どこで例題やツールを 探せばよいか知っておけば便利でしょう。そこでこの節では、ディレクトリ 構造について述べます。

ドキュメントソースは通常、Python ソース配布物中のDoc/ を トップレベルディレクトリとして配置されていますが、Python ソース配布物 には全く依存していません。

Doc/ ディレクトリには、いくつかのファイルとサブディレクトリ が入っています。ファイルはREADME や Makefile を含め、 ほとんどがその名の通りのファイルです。ディレクトリは以下の三つの カテゴリに分かれます:

ドキュメントソース
  各ドキュメントの LaTeX ソースは、それぞれ別々のディレクトリに 配置されています。 ディレクトリには、各々のドキュメントを漠然と説明する短い名前がついて います:

  ディレクトリ | タイトル
  --- | ---
  `api/` | Python/C API
  `dist/` | Python モジュールの配布
  `doc/` | Python ドキュメントの作成
  `ext/` | Python インタプリタの拡張と埋め込み
  `inst/` | Python モジュールのインストール
  `lib/` | Python ライブラリリファレンス
  `mac/` | Macintosh モジュールリファレンス
  `ref/` | Python リファレンスマニュアル
  `tut/` | Python チュートリアル
  `whatsnew/` | Python の更新情報

出力形式ごとの出力ディレクトリ
  ほとんどの出力形式に対して、出力結果のドキュメントを格納する ディレクトリがあり、その出力形式でのドキュメント生成を制御する Makefile が入っています。 このカテゴリの例外となるのは Portable Document Format (PDF) および PostScript 版で、これらは paper-a4/ および paper-letter/ に出力されます (こうすることで、LaTeX が生成する全ての一時ファイル が用紙サイズごとに同じ場所に置かれ、目立たなくなります)。

  ディレクトリ | 出力形式
  --- | ---
  `html/` | HTML 形式
  `info/` | GNU info 形式
  `isilo/` | iSilo ドキュメント (Palm OS 機器用)
  `paper-a4/` | PDF とPostScript、A4 サイズ
  `paper-letter/` | PDF と PostScript、US-Letter サイズ

補助ファイル群

  その他のディレクトリは、様々な処理で用いられる補助ファイルを格納 するためのものです。補助ファイルは、各ドキュメントで共通の LaTeX ドキュメントクラス、LaTeX2HTML のサポートファイル、ドキュメントの 構成要素となる雛形ファイル、フォーマット処理の様々なステップを実行 するスクリプトなどです。

  ディレクトリ | 内容
  --- | ---
  `commontex/` | ドキュメント間で共通の文章
  `perl/` | LaTeX2HTML 処理のサポート
  `templates/` | ソースドキュメントの例
  `texinputs/` | LaTeXスタイルファイル
  `tools/` | 独自の処理用スクリプト