Creating Documents

Creating documents with reStructuredText

The rst3 command converts an @rst tree to reStructuredText (rST) and sends the result to docutils or Sphinx for further processing.

With this tool chain, you can easily create HTML, PDF, LaTeX and other kinds of documents. All of Leo’s documentation is written in Sphinx and processed with the rst3 command to produce HTML files.

In “plain” rST, you denote sections by underlining heading names. Reorganizing an document is tedious: you have to change the underlining characters by hand.

In contrast, the rst3 command automatically creates rST sections from headlines. Reorganizing your document is easy–just reorganize your @rst tree. You don’t have to change rST markup!

The rst3 command provides many other capabilities for power users. For full details, see this chapter in Leo’s Users Guide.

Previous topic

External Files and Clones

Next topic

Programming with Leo