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
This commit is contained in:
parent
2583d574d2
commit
a2d9d35b3b
@ -61,7 +61,6 @@ django.setup()
|
|||||||
extensions = ['sphinx.ext.todo',
|
extensions = ['sphinx.ext.todo',
|
||||||
'sphinx.ext.coverage',
|
'sphinx.ext.coverage',
|
||||||
'sphinx.ext.viewcode',
|
'sphinx.ext.viewcode',
|
||||||
'sphinxcontrib.apidoc',
|
|
||||||
'openstackdocstheme',
|
'openstackdocstheme',
|
||||||
]
|
]
|
||||||
|
|
||||||
@ -128,13 +127,6 @@ pygments_style = 'sphinx'
|
|||||||
primary_domain = 'py'
|
primary_domain = 'py'
|
||||||
nitpicky = False
|
nitpicky = False
|
||||||
|
|
||||||
# sphinxcontrib-apidoc
|
|
||||||
apidoc_module_dir = '../../zun_ui'
|
|
||||||
apidoc_output_dir = 'contributor/api'
|
|
||||||
apidoc_excluded_paths = [
|
|
||||||
'test',
|
|
||||||
]
|
|
||||||
|
|
||||||
# -- Options for HTML output --------------------------------------------------
|
# -- Options for HTML output --------------------------------------------------
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
|
@ -1,9 +0,0 @@
|
|||||||
=====================
|
|
||||||
Source Code Reference
|
|
||||||
=====================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
:glob:
|
|
||||||
|
|
||||||
api/*
|
|
@ -7,11 +7,3 @@ There is no topic specific to Zun UI now.
|
|||||||
See `Horizon Contributor Documentation
|
See `Horizon Contributor Documentation
|
||||||
<https://docs.openstack.org/horizon/latest/contributor/index.html>`__
|
<https://docs.openstack.org/horizon/latest/contributor/index.html>`__
|
||||||
for general topic on developing a dashboard on horizon.
|
for general topic on developing a dashboard on horizon.
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
api
|
|
||||||
|
Loading…
Reference in New Issue
Block a user