5 ドキュメントクラス

2つの L^ATEX ドキュメントクラスが Python ドキュメントで使うために定義されています。manual クラスは、章単位で区分するような大きなドキュメントのためのクラスです。howto クラスはより小さなドキュメントのためのクラスです。

manual ドキュメントは大規模で、ほとんどの標準ドキュメントが使うクラスです。このドキュメントクラスは標準 L^ATEX の report クラスに基づいていて、まるで長い技術的報告書のように書式化されます。ます。Python リファレンスマニュアル は manual ドキュメントのよい例です。また、 Python Library Reference は大規模な文書の例です。

howto ドキュメントはより短く、manual ドキュメントのような大きな構造を持ちません。このクラスは標準 L^ATEX のarticle クラスに基づいていて、Linux Documentation プロジェクトの ``HOWTO'' シリーズのように書式化されます。``HOWTO'' シリーズはもともと LinuxDoc ソフトウェアを使って書式化を行っています。このドキュメントクラスの本来の目的は、 LDP の HOWTO シリーズと同様の役割として役立つことでしたが、このクラスにはより広範囲な適用性があることが判明したのです。このクラスは ``how-to'' ドキュメント (このドキュメントがその一例です) や、小規模で、かなり強い関連性で結ばれたモジュールライブラリ群のリファレンスマニュアルに用いられます。後者のドキュメントクラスの例には Using Kerberos from Python があります。これらのドキュメントは、大きなドキュメントにおける一個の章とだいたい同じ規模です。

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。