 |
 |
 |
Python ドキュメントの作成 |  |
 |
|
|
|
|
Python ドキュメントの作成 | |
|
|
Python のドキュメントは、このフリーなプログラミング言語の長所であると 考えられてきました。その理由は多々ありますが、最も重要なのは、 Python の作者である Guido van Rossum が、言語やそのライブラリの ドキュメントの提供と、ドキュメントの作成と維持の手助けする上での ユーザコミュニティの継続的な参加に早期から関わっていたことです。
コミュニティの参加には、バグ報告の作成から、単にドキュメントをより 完全で利用しやすいものにできる場合に素朴な提案をするといったこと まで、いくつものやりかたがあります。 筆者自身、ドキュメントの維持に参加している中で、こうしたコミュニティか ら寄せられる入力全てが有用だと確信させられました。
このドキュメントは、Python のドキュメントの作者、あるいは潜在的な 作者向けのものです。もっと具体的にいうと、標準ドキュメントに貢献 したり、標準ドキュメントと同じツールを使って別のドキュメントを 開発する人々向けです。 このガイドは Python 以外のトピックに Python ドキュメント作成 ツールを使う作者にとってはあまり有用ではなく、ツールを全く使用しない 作者にもあまり有用ではないでしょう。
このガイドに書かれていることは、Python ドキュメント作成ツールを使う 著者の支援を目的としています。ガイドには、標準ドキュメントのソース 配布に関する情報、ドキュメントタイプに関する議論、ドキュメントクラス 中で定義されているマークアップについてのリファレンス、ドキュメントを 処理する上で必要な外部ツールのリスト、ドキュメントリソースと共に提供 されているツールに関するリファレンスが入っています。 ガイドの末尾には、Python ドキュメントの将来の方向性と、詳細な情報を どこで取得できるかについて議論した章もあります。
仮に、あなたが Python のドキュメントを寄贈したいと思っている一方で、 LaTeX を学んだり、このドキュメントに書かれているマークアップ構造を 学んだりする時間や気力を持てないとしても、あなたを Python プロジェクト への協力者として迎え入れる余地はあります。 既存のドキュメントを改善したり、欠けているドキュメントを提供して もらえるなら、現在のドキュメント製作チームがいつでも喜んでマークアップ を行い、テキストを組み込みます。手助けしたいという気持ちをお持ちなら、 このドキュメントに書かれていることを障害のように思わないでくださいね！
|
|
|
Python ドキュメントの作成 | |
|
|