5 ドキュメントクラス

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

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

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

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