3 #############################
4 reStructured Text Style Guide
5 #############################
7 Most of the these documents are written ins reStructured Text (rst). This chapter describes some of
8 the Sphinx Markup Constructs used in these documents. The Sphinx style guide can be found at:
9 `Sphinx Style Guide <http://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html>`_
10 For a more detailed list of Sphinx Markup Constructs please refer to:
11 `Sphinx Markup Constructs <http://www.sphinx-doc.org/en/stable/markup/index.html>`_
13 This document is also an example of a directory structure for a document that spans mutliple pages.
14 Notice we have the file **index.rst** and the then documents that are referenced in index.rst. The
15 referenced documents are shown at the bottom of this page.
17 A label is shown at the top of this page. Then the first construct describes a the document title
18 **FD.io Style Guide**. Text usually follows under each title or heading.
20 A **Table of Contents** structure is shown below. Using **toctree** in this way will show the headings
21 in a nicely in the generated documents.