From ed0eccb13571fc1fbec3de8fd1b6994d34ba637b Mon Sep 17 00:00:00 2001 From: Kurt Griffiths Date: Fri, 6 Feb 2015 17:47:47 -0600 Subject: [PATCH] doc: Make the docs index more hierarchical With the standard RTD theme, the navigation sidebar flattens all TOCs listed on the index page. Hack around this to make things look more organized. --- doc/api/index.rst | 14 ++++++++++++ doc/changes/index.rst | 6 ++++++ doc/community/index.rst | 9 ++++++++ doc/index.rst | 47 ++++++----------------------------------- doc/user/index.rst | 10 +++++++++ 5 files changed, 45 insertions(+), 41 deletions(-) create mode 100644 doc/api/index.rst create mode 100644 doc/changes/index.rst create mode 100644 doc/community/index.rst create mode 100644 doc/user/index.rst diff --git a/doc/api/index.rst b/doc/api/index.rst new file mode 100644 index 0000000..7a8fea3 --- /dev/null +++ b/doc/api/index.rst @@ -0,0 +1,14 @@ +Classes and Functions +===================== + +.. toctree:: + :maxdepth: 2 + + api + request_and_response + status + errors + middleware + hooks + routing + util \ No newline at end of file diff --git a/doc/changes/index.rst b/doc/changes/index.rst new file mode 100644 index 0000000..75a90a7 --- /dev/null +++ b/doc/changes/index.rst @@ -0,0 +1,6 @@ +Changelogs +========== + +.. toctree:: + + 0.2.0 <0.2.0> \ No newline at end of file diff --git a/doc/community/index.rst b/doc/community/index.rst new file mode 100644 index 0000000..444c963 --- /dev/null +++ b/doc/community/index.rst @@ -0,0 +1,9 @@ +Community Guide +=============== + +.. toctree:: + :maxdepth: 1 + + help + contribute + faq \ No newline at end of file diff --git a/doc/index.rst b/doc/index.rst index 7b7756a..d62667a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -80,48 +80,13 @@ Resources - `An Unladen Web Framework `_ - `The Definitive Introduction to Falcon `_ -Community Guide ---------------- - -.. toctree:: - :maxdepth: 1 - - community/help - community/contribute - community/faq - - -User Guide ----------- +Documentation +------------- .. toctree:: :maxdepth: 2 - user/intro - user/install - user/quickstart - user/tutorial - - -Classes and Functions ---------------------- - -.. toctree:: - :maxdepth: 2 - - api/api - api/request_and_response - api/status - api/errors - api/middleware - api/hooks - api/routing - api/util - -Changelogs ----------- - -.. toctree:: - :glob: - - changes/* + community/index + user/index + api/index + changes/index diff --git a/doc/user/index.rst b/doc/user/index.rst new file mode 100644 index 0000000..c920e4e --- /dev/null +++ b/doc/user/index.rst @@ -0,0 +1,10 @@ +User Guide +========== + +.. toctree:: + :maxdepth: 2 + + intro + install + quickstart + tutorial \ No newline at end of file