Added code docs

Bernardo-MG · Nov 1, 2016 · 2fd5ee7 · 2fd5ee7
1 parent 110e005
commit 2fd5ee7
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 1 deletion.
diff --git a/{{cookiecutter.package_name}}/docs/source/code/index.rst b/{{cookiecutter.package_name}}/docs/source/code/index.rst
@@ -0,0 +1,7 @@
+=========
+Code docs
+=========
+
+.. toctree::
+
+   placeholder
diff --git a/{{cookiecutter.package_name}}/docs/source/code/placeholder.rst b/{{cookiecutter.package_name}}/docs/source/code/placeholder.rst
@@ -0,0 +1,9 @@
+==================
+Placeholder module
+==================
+
+.. automodule:: placeholder
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
diff --git a/{{cookiecutter.package_name}}/docs/source/conf.py b/{{cookiecutter.package_name}}/docs/source/conf.py
@@ -116,7 +116,8 @@
                            ('Usage', './usage.html')],
     'navbar_links': [('Documentation', [('Acquire', './acquire.html'),
                                         ('Usage', './usage.html')]),
-                     ('Info and Reports', [('Reports', './reports.html')])],
+                     ('Info and Reports', [('Reports', './reports.html'),
+                                           ('Code docs', './code/index.html')])],
 }
 
 # Output file base name for HTML help builder.

diff --git a/{{cookiecutter.package_name}}/docs/source/index.rst b/{{cookiecutter.package_name}}/docs/source/index.rst
@@ -19,3 +19,4 @@ Features
    acquire
    usage
    reports
+   docs/dice