From 7f37f7b92a096405ce24485589ae450baa654e2d Mon Sep 17 00:00:00 2001 From: licanwei Date: Tue, 4 Jun 2019 11:24:43 +0800 Subject: [PATCH] Remove apidoc Now there are some errors when running apidoc, actually we don't need apidoc, so remove it. Closes-Bug: #1831515 Change-Id: I3b91a2c05ed62ae7bbd30a29e9db51d0e021410f --- doc/source/conf.py | 17 ----------------- doc/source/index.rst | 9 --------- 2 files changed, 26 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index fda641b64..44d81d6c4 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -32,7 +32,6 @@ sys.path.insert(0, os.path.abspath('./')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'oslo_config.sphinxext', - 'sphinxcontrib.apidoc', 'sphinx.ext.viewcode', 'sphinxcontrib.httpdomain', 'sphinxcontrib.pecanwsme.rest', @@ -51,22 +50,6 @@ config_generator_config_file = [( '_static/watcher')] sample_config_basename = 'watcher' -# 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 - -# sphinxcontrib.apidoc options -apidoc_module_dir = '../../watcher' -apidoc_output_dir = 'api' -apidoc_excluded_paths = [ - 'tests/*', - 'db', - 'decision_engine', - 'doc', - 'objects', -] -apidoc_separate_modules = True - # The suffix of source filenames. source_suffix = '.rst' diff --git a/doc/source/index.rst b/doc/source/index.rst index 700e678eb..83069cc46 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -111,15 +111,6 @@ Watcher Manual Pages man/index -.. # NOTE(mriedem): This is the section where we hide things that we don't - # actually want in the table of contents but sphinx build would fail if - # they aren't in the toctree somewhere. For example, we hide api/autoindex - # since that's already covered with modindex below. -.. toctree:: - :hidden: - - api/modules - Indices and tables ==================