From f02045ce4cd4ae9d1ee967132cbb916fd0639bd5 Mon Sep 17 00:00:00 2001 From: Eric K Date: Wed, 18 Jul 2018 11:51:13 -0700 Subject: [PATCH] doc update to fix errors from new sphinx version 1.7.5 Change-Id: I3598e0ed6e70454de63fd7551a381122d42693b8 --- doc/source/conf.py | 7 +++++++ doc/source/index.rst | 4 ++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index a526df1..7a165cb 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 58d8047..ddc8b41 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 \ No newline at end of file + reference/api/modules