[tor-commits] [stem/master] Adding toctree declarations

[atagar at torproject.org]

commit 3c04eb6092371526126ef745903bb3e96782511a
Author: Damian Johnson <atagar at torproject.org>
Date:   Thu Oct 25 09:17:35 2012 -0700

    Adding toctree declarations
    
    Sphinx gives a warning saying "document isn't included in any toctree" if all
    *.rst documents aren't included in a toctree somewhere. I'm not using a toctree
    as our primary form of navigation so it doesn't really make sense, but it's
    easy enough to make a contents page off to the side that satisfies sphinx.
---
 docs/contents.rst |   14 ++++++++++++++
 docs/index.rst    |    5 +++++
 2 files changed, 19 insertions(+), 0 deletions(-)

diff --git a/docs/contents.rst b/docs/contents.rst
new file mode 100644
index 0000000..7565543
--- /dev/null
+++ b/docs/contents.rst
@@ -0,0 +1,14 @@
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+   download
+   tutorial
+
+   descriptor/reader
+   types/exit_policy
+   types/version
+
diff --git a/docs/index.rst b/docs/index.rst
index aa5ab03..edfab3f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -19,5 +19,10 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
+.. toctree::
+   :maxdepth: 1
+
+   contents
+
 *Last updated:* |today|