### ナビゲーション

- 索引
- モジュール |
- 次へ |
- 前へ |
- Python v2.6.2 documentation »

# Python のドキュメントの作成

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

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

Python のドキュメントを寄贈したいと思っているなら、そのために reStructuredText をわざわざ学ぶ必要はありません; 平文での寄贈も大歓迎です。

- 1. 初めに
- 2. スタイルガイド
- 3. reStructuredText の基礎
  - 3.1. 段落 (Paragraphs)
  - 3.2. インラインマークアップ (Inline markup)
  - 3.3. リストとクォート (Lists and Quotes)
  - 3.4. ソースコード (Source Code)
  - 3.5. ハイパーリンク (Hyperlinks)
    - 3.5.1. 外部リンク (External links)
    - 3.5.2. 内部リンク (Internal links)
    - 3.5.3. セクション
  - 3.6. 明示的なマークアップ (Explicit Markup)
  - 3.7. ディレクティブ (Directives)
  - 3.8. 脚注 (Footnotes)
  - 3.9. コメント (Comments)
  - 3.10. ソースのエンコード (Source encoding)
  - 3.11. 判っていること
- 4. 拡張マークアップ構成部 (Additional Markup Constructs)
  - 4.1. メタ情報マークアップ (Meta-information markup)
  - 4.2. モジュール用のマークアップ (Module-specific markup)
  - 4.3. 情報単位 (Information units)
  - 4.4. コードサンプルを表示する (Showing code examples)
  - 4.5. インラインマークアップ (Inline markup)
  - 4.6. クロスリンクのマークアップ (Cross-linking markup)
  - 4.7. 段落レベルでのマークアップ (Paragraph-level markup)
  - 4.8. Table-of-contents マークアップ (Table-of-contents markup)
  - 4.9. インデックス生成マークアップ (Index-generating markup)
  - 4.10. 文法導出表記 (Grammar production displays)
  - 4.11. 置換 (Substitutions)
- 5. LaTeX マークアップとの違い
  - 5.1. インラインマークアップ
  - 5.2. 情報単位 (information units)
  - 5.3. 構造 (Structure)
- 6. このドキュメントについて
- 7. 翻訳者一覧 (敬称略)

### ナビゲーション

- 索引
- モジュール |
- 次へ |
- 前へ |
- Python v2.6.2 documentation »