summaryrefslogtreecommitdiff
path: root/doc/source/conf.py
diff options
context:
space:
mode:
authorMichael Johnson <johnsomor@gmail.com>2022-02-14 18:50:55 +0000
committerMichael Johnson <johnsomor@gmail.com>2022-02-17 22:35:09 +0000
commitb9206a5349724a179cf90fbd7f09555cfbbd7fd1 (patch)
tree6ddaabe7e9f10d7306d8d8131865eb5492819e30 /doc/source/conf.py
parenta2e5a66696242b0f7d0b2066c8606c9a029959d3 (diff)
downloadosprofiler-b9206a5349724a179cf90fbd7f09555cfbbd7fd1.tar.gz
Fix api index and module index
This patch fixes the index and module index for the osprofiler documentation home page. It also updates the documents tox environments to use a docs requirements.txt Change-Id: I880f1c28232a299f50ea9ccc2178f1444efb9a41
Diffstat (limited to 'doc/source/conf.py')
-rw-r--r--doc/source/conf.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index f904f7f..a9a2e79 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -49,6 +49,7 @@ extensions = [
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'openstackdocstheme',
+ 'sphinxcontrib.apidoc',
]
# openstackdocstheme options
@@ -130,3 +131,10 @@ texinfo_documents = [
'Miscellaneous'
),
]
+
+apidoc_output_dir = 'contributor/modules'
+apidoc_module_dir = '../../osprofiler'
+apidoc_excluded_paths = [
+ 'hacking',
+ 'tests',
+]