openstack/oslo.cache
Code Issues Proposed changes

Avoid use of autodoc_tree_index_modules

Browse Source 
Changes doc jobs to not user the pbr autodoc_tree_index_modules
directive to generate module documentation by using the new
sphinxcontrib.apidoc extension.

Depends-On: https://review.openstack.org/560379/
Change-Id: Idc84455cf78b6114b31109b7ef9ab3ac9c97e136
This commit is contained in:
Sean McGinnis 2018-03-21 17:10:47 -05:00 committed by Doug Hellmann
parent 5af2f67799
commit 6507ff752e
4 changed files with 10 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/requirements.txt
View File

@ -9,6 +9,7 @@ reno>=2.5.0 # Apache-2.0
python-memcached>=1.56 # PSF python-memcached>=1.56 # PSF
pymongo!=3.1,>=3.0.2 # Apache-2.0 pymongo!=3.1,>=3.0.2 # Apache-2.0
etcd3gw>=0.2.0 # Apache-2.0 etcd3gw>=0.2.0 # Apache-2.0
sphinxcontrib-apidoc>=0.2.0 # BSD
# For autodoc builds # For autodoc builds
mock>=2.0.0 # BSD mock>=2.0.0 # BSD

13
doc/source/conf.py
View File

@ -21,7 +21,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinxcontrib.apidoc',
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
'openstackdocstheme', 'openstackdocstheme',
'oslo_config.sphinxext', 'oslo_config.sphinxext',
@ -32,13 +32,16 @@ repository_name = 'openstack/oslo.cache'
bug_project = 'oslo.cache' bug_project = 'oslo.cache'
bug_tag = '' bug_tag = ''
# sphinxcontrib.apidoc options
apidoc_module_dir = '../../oslo_cache'
apidoc_output_dir = 'reference/api'
apidoc_excluded_paths = [
'tests'
]
# Must set this variable to include year, month, day, hours, and minutes. # Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M' html_last_updated_fmt = '%Y-%m-%d %H:%M'
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.rst'

2
doc/source/reference/index.rst
View File

@ -7,4 +7,4 @@ Reference
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
api/modules Modules <api/modules>

13
setup.cfg
View File

@ -40,19 +40,6 @@ mongo =
etcd3gw = etcd3gw =
etcd3gw>=0.2.0 # Apache-2.0 etcd3gw>=0.2.0 # Apache-2.0
[pbr]
autodoc_tree_index_modules = True
api_doc_dir = reference/api
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
warning-is-error = 1
[upload_sphinx]
upload-dir = doc/build/html
[compile_catalog] [compile_catalog]
directory = oslo_cache/locale directory = oslo_cache/locale
domain = oslo_cache domain = oslo_cache