前のトピックへ

このドキュメントについて

次のトピックへ

1. 初めに

このページ

Python のドキュメントの作成

Python には様々な著者により寄稿された非常に多くのドキュメント類があります。 Python のドキュメントのマークアップには、 docutils プロジェクトによって開発された reStructuredText を、独自のディレクティブ (directive) で拡張して利用しています。そして、 Sphinx というツールセットを利用して、HTML 出力へと変換しています。

このドキュメントでは、ドキュメントを作成する上でのスタイルガイドと、 Python のドキュメントのために作られた Sphinx による独自の reStructuredText マークアップとその利用方法を説明します。

ノート

Python のドキュメントを寄贈したいと思っているなら、そのために reStructuredText をわざわざ学ぶ必要はありません; 平文での寄贈も大歓迎です。 Eメールで docs@python.org に送るか、 Tracker に課題 (issue) を登録してください。