Writing tips for sphinx and other formats
For output formats different from latex, pdflatex, and html:
- Use labels only right after section headings and in equations.
- Be careful with labels in
align math environments: pandoc
and mwiki cannot refer to them.
-
sphinx output requires
- no math in section headings or figure captions
(gets removed in references).
- running text to start in column 1.
- progressive section headings: after chapter (9
=) comes
section (7 =), then subsection (5 =), then paragraph
(3 =). Do not make jumps in this progression.
- index entries (``) before the paragraph where they
are introduced and place them before subsubsection
headings (
=== ... ===) and after subsection and section headings.
- a line of text and no comment or math before code or list.