reStructured Text Style GuideΒΆ

Most of the these documents are written ins reStructured Text (rst). This chapter describes some of the Sphinx Markup Constructs used in these documents. The Sphinx style guide can be found at: Sphinx Style Guide For a more detailed list of Sphinx Markup Constructs please refer to: Sphinx Markup Constructs

This document is also an example of a directory structure for a document that spans mutliple pages. Notice we have the file index.rst and the then documents that are referenced in index.rst. The referenced documents are shown at the bottom of this page.

A label is shown at the top of this page. Then the first construct describes a the document title Style Guide. Text usually follows under each title or heading.

A Table of Contents structure is shown below. Using toctree in this way will show the headings in a nicely in the generated documents.