Documenting Python

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

---

Contents

• 1 Introduction
• 2 Directory Structure
• 3 L^ATEX Primer
  • 3.1 Syntax
  • 3.2 Hierarchical Structure
  
  
• 4 Document Classes
• 5 Special Markup Constructs
  • 5.1 Markup for the Preamble
  • 5.2 Meta-information Markup
  • 5.3 Information Units
  • 5.4 Showing Code Examples
  • 5.5 Inline Markup
  • 5.6 Module-specific Markup
  • 5.7 Library-level Markup
  • 5.8 Table Markup
  • 5.9 Reference List Markup
  • 5.10 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
  
  
• About this document ...

---

Documenting Python

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

---

Release 2.1.3, documentation updated on April 3, 2002.