From a451b28c434be314c3e626fa3c4f444bb1acd979 Mon Sep 17 00:00:00 2001 From: melissaml Date: Fri, 20 Apr 2018 14:44:58 +0800 Subject: Follow the new PTI for document build For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Co-Authored-By: Nguyen Hai Change-Id: Ia0a27229f09467980ff4af014001febb017bb36d --- doc/requirements.txt | 1 + doc/source/conf.py | 16 ++++++++++++---- 2 files changed, 13 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/requirements.txt b/doc/requirements.txt index 75c6c19..6e62d8d 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -7,6 +7,7 @@ doc8>=0.6.0 # Apache-2.0 openstackdocstheme>=1.18.1 # Apache-2.0 reno>=2.5.0 # Apache-2.0 sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +sphinxcontrib-apidoc>=0.2.0 # BSD # For autodoc builds mock>=2.0.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 0cef1f7..9e8aaff 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -10,7 +10,6 @@ # All configuration values have a default; values that are commented out # serve to show the default. -from __future__ import unicode_literals import os import sys @@ -37,14 +36,23 @@ sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), # Add any Sphinx extension module names here, as strings. They can be # extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', - 'sphinx.ext.todo', +extensions = ['sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.intersphinx', 'openstackdocstheme', - 'oslo_config.sphinxconfiggen' + 'oslo_config.sphinxconfiggen', + 'sphinxcontrib.apidoc', ] +# sphinxcontrib.apidoc options +apidoc_module_dir = '../../keystonemiddleware' +apidoc_output_dir = 'api' +apidoc_excluded_paths = [ + 'tests/*', + 'tests', + 'test'] +apidoc_separate_modules = True + config_generator_config_file = '../../config-generator/keystonemiddleware.conf' sample_config_basename = '_static/keystonemiddleware' -- cgit v1.2.1