#
2 ディレクトリ構造

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

ドキュメントソースは通常、Doc/ をトップレベルディレクトリとして Python ソース配布物中に配置されていますが、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 チュートリアル

出力書式ごとの出力ディレクトリ
  ほとんどの出力書式に対して、個々の出力書式の生成を制御する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/` | 独自の処理用スクリプト