summaryrefslogtreecommitdiff
path: root/setup.cfg
diff options
context:
space:
mode:
authorDavid Stanek <dstanek@dstanek.com>2013-10-21 14:10:27 +0000
committerDavid Stanek <dstanek@dstanek.com>2013-12-13 02:47:37 +0000
commit3f27b309f0d08dff3d3ea1e6aa05c3d2f46b81be (patch)
treecf7be879f6c9024bd60dbd6917088587e0abb09c /setup.cfg
parent35242b04eb73f41e3ecb9391697087d54464f480 (diff)
downloadkeystone-3f27b309f0d08dff3d3ea1e6aa05c3d2f46b81be.tar.gz
Fixes documentation building
- Adds the ability to build docs using tox - Fixes autodoc generation A Sphinx extension is introduced in the commit to facilitate building the API documentation. This extension should be removed when bug 1260495 is fixed. Change-Id: Ibf5e5403cb7d3e67947c87b2828b64a56a11fc30
Diffstat (limited to 'setup.cfg')
-rw-r--r--setup.cfg6
1 files changed, 6 insertions, 0 deletions
diff --git a/setup.cfg b/setup.cfg
index 6654aabd0..4ef1122a6 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -55,3 +55,9 @@ mapping_file = babel.cfg
output_file = keystone/locale/keystone.pot
copyright_holder = OpenStack Foundation
msgid_bugs_address = https://bugs.launchpad.net/keystone
+
+# NOTE(dstanek): Uncomment the [pbr] section below and remove the ext.apidoc
+# Sphinx extension when https://launchpad.net/bugs/1260495 is fixed.
+#[pbr]
+#autodoc_tree_index_modules = True
+#autodoc_tree_root = ./keystone