From a2d9d35b3b772055aa3375496a174b475e0c62db Mon Sep 17 00:00:00 2001 From: Hongbin Lu Date: Sat, 26 Oct 2019 20:32:00 +0000 Subject: [PATCH] Disable auto-generate API docs First, the autodoc build is failing. Second, zun-ui is a horizon plugin so auto-generated api docs don't seem to have much value. This commit removes autodoc extension which basically stops auto-generated API docs. Change-Id: I3687a2b46fa524bb902bf8031c4d77945fb0c216 Closes-Bug: #1849990 --- doc/source/conf.py | 8 -------- doc/source/contributor/api.rst | 9 --------- doc/source/contributor/index.rst | 8 -------- 3 files changed, 25 deletions(-) delete mode 100644 doc/source/contributor/api.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index e723a9a..26e9453 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -61,7 +61,6 @@ django.setup() extensions = ['sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', - 'sphinxcontrib.apidoc', 'openstackdocstheme', ] @@ -128,13 +127,6 @@ pygments_style = 'sphinx' primary_domain = 'py' nitpicky = False -# sphinxcontrib-apidoc -apidoc_module_dir = '../../zun_ui' -apidoc_output_dir = 'contributor/api' -apidoc_excluded_paths = [ - 'test', -] - # -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for diff --git a/doc/source/contributor/api.rst b/doc/source/contributor/api.rst deleted file mode 100644 index dd3be26..0000000 --- a/doc/source/contributor/api.rst +++ /dev/null @@ -1,9 +0,0 @@ -===================== -Source Code Reference -===================== - -.. toctree:: - :maxdepth: 1 - :glob: - - api/* diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 85deaab..2428b78 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -7,11 +7,3 @@ There is no topic specific to Zun UI now. See `Horizon Contributor Documentation `__ for general topic on developing a dashboard on horizon. - ----- - -.. toctree:: - :glob: - :maxdepth: 1 - - api