#
1 初めに

Python のドキュメントは、このフリーなプログラミング言語の長所であると 考えられてきました。その理由は多々ありますが、最も重要なのは、 Python の作者である Guido van Rossum が、言語やそのライブラリの ドキュメントの提供と、ドキュメントの作成と維持の手助けする上での ユーザコミュニティの継続的な参加に早期から関わっていたことです。

コミュニティの参加には、バグ報告の作成から、単にドキュメントがより 完全で利用しやすいものになりうる場合に素朴な提案を発するといったこと まで、数多くの形式があります。 作者がドキュメントの維持に参加している中で、こうしたコミュニティからの 入力の全てが有用なものであると証明されました。

このドキュメントは、Python のドキュメントの作者、あるいは潜在的な 作者向けのものです。もっと具体的にいうと、標準ドキュメントに貢献 したり、標準ドキュメントと同じツールを使って別のドキュメントを 開発する人々向けです。 このガイドは Python 以外のトピックに Python ドキュメント作成 ツールを使う作者にとってはあまり有用ではなく、ツールを全く使用しない 作者にもあまり有用ではないでしょう。

このガイドに書かれていることは、Python ドキュメント作成ツールを使う 著者の支援を目的としています。ガイドには、標準ドキュメントのソース 配布に関する情報、ドキュメントタイプに関する議論、ドキュメントクラス中で で定義されているマークアップについてのリファレンス、ドキュメントを処理する 上で必要な外部ツールのリスト、ドキュメントリソースと共に提供されている ツールに関するリファレンスが入っています。ガイドの末尾には、Python ドキュメントの将来の方向性と、詳細な情報をどこで取得できるかについて 議論した章もあります。