Working out how to use documentation tools

cheba-nil · May 6, 2019 · 823fc2d · 823fc2d
1 parent 582c498
commit 823fc2d
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 21 deletions.
diff --git a/docs/source/code/TemplateClasses.rst b/docs/source/code/TemplateClasses.rst
@@ -0,0 +1,18 @@
+TemplateClasses
+===============
+
+.. automodule:: WMH_extraction.TemplateClasses
+
+:mod:`WMH_extraction.TemplateClasses` is a collection of classes used to provide information and paths relavent to the Template they help implement.
+
+AbstractTemplate
+----------------
+.. autoclass:: WMH_extraction.TemplateClasses.AbstractTemplate
+    :show-inheritance:
+    :members:
+
+CohortTemplate
+--------------
+.. autoclass:: WMH_extraction.TemplateClasses.CohortTemplate
+    :show-inheritance:
+    :members:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -193,13 +193,13 @@
     'canonical_url': '',
     'analytics_id': 'UA-139625346-1',  #  Provided by Google in your dashboard
     'logo_only': False,
-    'display_version': True,
+    'display_version': False,
     'prev_next_buttons_location': 'bottom',
     'style_external_links': False,
     'vcs_pageview_mode': '',
     'style_nav_header_background': 'white',
     # Toc options
-    'collapse_navigation': True,
+    'collapse_navigation': False,
     'sticky_navigation': True,
     'navigation_depth': 4,
     'includehidden': True,

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,32 +7,17 @@ Welcome to CNS's documentation!
 ===============================
 
 .. toctree::
+   :hidden:
    :maxdepth: 2
+   :glob:
    :caption: Contents:
 
+   install/install
+   code/*
 
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`search`
-
-TemplateClasses
-===============
-
-.. automodule:: WMH_extraction.TemplateClasses
-
-:mod:`WMH_extraction.TemplateClasses` is a collection of classes used to provide information and paths relavent to the Template they help implement.
-
-AbstractTemplate
-----------------
-.. autoclass:: WMH_extraction.TemplateClasses.AbstractTemplate
-    :show-inheritance:
-    :members:
-
-CohortTemplate
---------------
-.. autoclass:: WMH_extraction.TemplateClasses.CohortTemplate
-    :show-inheritance:
-    :members:
diff --git a/docs/source/install/install.rst b/docs/source/install/install.rst
@@ -0,0 +1,7 @@
+How To Install
+==============
+
+TODO
+-----------
+
+Include Install Instructions