openstack/python-congressclient
Code Issues Proposed changes

doc update to fix errors from new sphinx version 1.7.5

Browse Source 
Change-Id: I3598e0ed6e70454de63fd7551a381122d42693b8
This commit is contained in:
Eric K 2018-07-18 11:51:13 -07:00
parent 2d55e1f26e
commit f02045ce4c
2 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/conf.py
View File

@ -33,6 +33,8 @@ bug_tag = ''
# sphinxcontrib.apidoc options
apidoc_module_dir = '../../congressclient'
apidoc_output_dir = 'reference/api'
apidoc_excluded_paths = ['tests/*']
apidoc_separate_modules = True
# Must set this variable to include year, month, day, hours, and minutes.
@ -62,6 +64,11 @@ add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of glob-style patterns that should be excluded when looking for
# source files. They are matched against the source file names relative to the
# source directory, using slashes as directory separators on all platforms.
exclude_patterns = ['reference/api/congressclient.tests.*']
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with

4
doc/source/index.rst
View File

@ -22,8 +22,8 @@ Contents:
.. # Below are items we don't want to show doc consumers but need to be
# included to avoid sphinx warning/error.
# api/autoindex hidden because the information is already in modindex above
# api/modules hidden because the information is already in modindex above
.. toctree::
:hidden:
reference/api/autoindex
reference/api/modules