Documenting Python

Previous: 4.1 Syntax Up: 4 L^ATEX Primer Next: 5 Document Classes

---

 
4.2 Hierarchical Structure

L^ATEX expects documents to be arranged in a conventional, hierarchical way, with chapters, sections, sub-sections, appendixes, and the like. These are marked using macros rather than environments, probably because the end of a section can be safely inferred when a section of equal or higher level starts.

There are six ``levels'' of sectioning in the document classes used for Python documentation, and the deepest two levels¹ are not used. The levels are:

Level	Macro Name	Notes
1	\chapter	(1)
2	\section
3	\subsection
4	\subsubsection
5	\paragraph	(2)
6	\subparagraph

Notes:

(1)

Only used for the manual documents, as described in section 5, ``Document Classes.''

(2)

Not the same as a paragraph of text; nobody seems to use this.

Footnotes

... levels¹

The deepest levels have the highest numbers in the table.

---

Documenting Python

Previous: 4.1 Syntax Up: 4 L^ATEX Primer Next: 5 Document Classes

---

Release 2.2.2, documentation updated on October 14, 2002.