Add some autodoc'ing.

This does not work as desired but might be a helpful starting point for
PyconUK · May 13, 2017 · b2bc341 · b2bc341
1 parent 7658a17
commit b2bc341
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,8 +18,9 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import sys
+sys.path.insert(0, os.path.abspath('../src/'))
+import conference_scheduler.scheduler
 
 # -- General configuration ------------------------------------------------
 
@@ -31,6 +32,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinx.ext.autodoc',
     'sphinx.ext.mathjax',
     'sphinx.ext.todo'
 ]

diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ Contents:
    tutorial/index.rst
    howto/index.rst
    background/index.rst
+   reference/index.rst
 
 
 

diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -0,0 +1,8 @@
+Reference
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+.. automodule:: conference_scheduler.scheduler
+   :members: