Documenting Python

Next: 1. Introduction Up: Documenting Python Previous: Documenting Python

---

Contents

• Contents
• 1. Introduction
• 2. Directory Structure
• 3. L^ATEX Primer
• 4. Document Classes
• 5. Special Markup Constructs
  • 5.1 Meta-information Markup
  • 5.2 Information Units
  • 5.3 Showing Code Examples
  • 5.4 Inline Markup
  • 5.5 Module-specific Markup
  • 5.6 Library-level Markup
  • 5.7 Table Markup
  • 5.8 Reference List Markup
  • 5.9 Index-generating Markup
• 6. Special Names
• 7. Processing Tools
  • 7.1 External Tools
  • 7.2 Internal Tools
• 8. Future Directions
  • 8.1 Structured Documentation
  • 8.2 Discussion Forums

---

Documenting Python

Next: 1. Introduction Up: Documenting Python Previous: Documenting Python