summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-11-20 21:39:35 -0800
committerSteve Piercy <web@stevepiercy.com>2016-11-20 21:39:35 -0800
commit7285651ecf3458c61158b8fcf7dbd269f067ffaf (patch)
treee8d892cdadfc03e062304ef265c7cd7032e248af
parentf69e9035d16110d67de5b5a5c0c94bde5bd6b359 (diff)
downloadpyramid-7285651ecf3458c61158b8fcf7dbd269f067ffaf.tar.gz
pyramid-7285651ecf3458c61158b8fcf7dbd269f067ffaf.tar.bz2
pyramid-7285651ecf3458c61158b8fcf7dbd269f067ffaf.zip
Add section structure
-rw-r--r--docs/style-guide.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/style-guide.rst b/docs/style-guide.rst
index 3f2b630d3..49c9d5950 100644
--- a/docs/style-guide.rst
+++ b/docs/style-guide.rst
@@ -47,6 +47,26 @@ Location, referencing, and naming of files
will select the image ``pyramid_request_processing.svg`` for the HTML documentation builder, and ``pyramid_request_processing.png`` for the PDF builder. See the related [Stack Overflow post](http://stackoverflow.com/questions/6473660/using-sphinx-docs-how-can-i-specify-png-image-formats-for-html-builds-and-pdf-im/6486713#6486713).
+.. _style-guide-section-structure:
+
+Section structure
+-----------------
+
+Each section, or a subdirectory of reST files, such as a tutorial, must contain an ``index.rst`` file. ``index.rst`` must contain the following.
+
+- A section heading. This will be visible in the table of contents.
+- A single paragraph describing this section.
+- A Sphinx ``toctree`` directive, with a ``maxdepth`` of 2. Each ``.rst`` file in the folder should be linked to this ``toctree``.
+
+ .. code-block:: rst
+
+ .. toctree::
+ :maxdepth: 2
+
+ chapter1
+ chapter2
+ chapter3
+
.. _style-guide-page-structure:
Page structure