summaryrefslogtreecommitdiff
path: root/doc/source/conf.py
diff options
authorThomas Goirand <zigo@debian.org>2018-08-22 15:31:26 +0200
committergit-ubuntu importer <ubuntu-devel-discuss@lists.ubuntu.com>2018-08-22 22:26:31 +0000
commitcc415b185206cd9a4e8b1a9940e30a072b214bd5 (patch)
tree46f860d50aaf848708f0a41d1120a1c96fa6c5e0 /doc/source/conf.py
parent57c17ecc011f179d98cfd3bad48d09868c288e03 (diff)
3.16.0-1 (patches unapplied)import/3.16.0-1
Imported using git-ubuntu import.
Notes
Notes: [ Ondřej Nový ] * d/control: Use team+openstack@tracker.debian.org as maintainer [ Thomas Goirand ] * New upstream release. * Fixed (build-)depends for this release. * Building sphinx doc with Python 3. * Remove fix-output-encoding.patch applied upstream.
Diffstat (limited to 'doc/source/conf.py')
-rw-r--r--doc/source/conf.py19
1 files changed, 11 insertions, 8 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index d7efbd7..003bfca 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -12,16 +12,8 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import os
-import sys
-
import pbr.version
-# 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.
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..')))
-
# -- General configuration ----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
@@ -35,6 +27,7 @@ extensions = ['sphinx.ext.autodoc',
'openstackdocstheme',
'stevedore.sphinxext',
'cliff.sphinxext',
+ 'sphinxcontrib.apidoc',
]
# openstackdocstheme options
@@ -282,3 +275,13 @@ autoprogram_cliff_application = 'openstack'
autoprogram_cliff_ignored = [
'--help', '--format', '--column', '--max-width', '--fit-width',
'--print-empty', '--prefix', '--noindent', '--quote']
+
+
+# -- Options for sphinxcontrib.apidoc ----------------------------------------
+
+apidoc_module_dir = '../../openstackclient'
+apidoc_excluded_paths = [
+ 'volume/v3',
+ 'tests',
+]
+apidoc_output_dir = 'contributor/api'