From b2bc34163da3dcccab0893eaea36acecf74e7655 Mon Sep 17 00:00:00 2001 From: Vince Knight Date: Sat, 13 May 2017 11:06:29 +0100 Subject: [PATCH] Add some autodoc'ing. This does not work as desired but might be a helpful starting point for --- docs/conf.py | 6 ++++-- docs/index.rst | 1 + docs/reference/index.rst | 8 ++++++++ 3 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 docs/reference/index.rst diff --git a/docs/conf.py b/docs/conf.py index f4d8104..0a50eeb 100644 --- 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 index 2af4055..6e06dee 100644 --- 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 new file mode 100644 index 0000000..7d9de83 --- /dev/null +++ b/docs/reference/index.rst @@ -0,0 +1,8 @@ +Reference +========= + +.. toctree:: + :maxdepth: 2 + +.. automodule:: conference_scheduler.scheduler + :members: