diff options
| author | Brant Knudson <bknudson@us.ibm.com> | 2014-02-10 18:47:37 -0600 |
|---|---|---|
| committer | Brant Knudson <bknudson@us.ibm.com> | 2014-03-13 19:31:21 -0500 |
| commit | fd59d02e933fe58aee93beddc9a4e655b3257e30 (patch) | |
| tree | b99143a477f595b4952ce127a1e2d069c499ccd8 /doc/source/conf.py | |
| parent | f12afc6c738bf58688614a9b3d641fabb5bc5787 (diff) | |
| download | python-keystoneclient-fd59d02e933fe58aee93beddc9a4e655b3257e30.tar.gz | |
Generate module docs
The module docs were not being generated.
Co-Authored-By: David Stanek <dstanek@dstanek.com>
Change-Id: I26e1d9a3d407474eb6b016f3ada4c495b5043460
Closes-Bug: #1278662
Diffstat (limited to 'doc/source/conf.py')
| -rw-r--r-- | doc/source/conf.py | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 354d08c..e0e877e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,6 +23,12 @@ import pbr.version sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))) +# NOTE(blk-u): Path for our Sphinx extension, remove when +# https://launchpad.net/bugs/1260495 is fixed. +sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), + '..'))) + + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -36,7 +42,12 @@ sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', - 'sphinx.ext.intersphinx'] + 'sphinx.ext.intersphinx', + # NOTE(blk-u): Uncomment the [pbr] section in setup.cfg and + # remove this Sphinx extension when + # https://launchpad.net/bugs/1260495 is fixed. + 'ext.apidoc', + ] todo_include_todos = True |