Replace pbr autodoc with sphinxcontrib-apidoc
This fixes local building of the documentation using tox, and allows the gate to stop relying on pbr and move completely to the new docs PTI. http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: I6ef3e102f5a169262efbbaeec61452f0a2443fb4 Depends-On: https://review.openstack.org/560577
This commit is contained in:
parent
dea4bd18e0
commit
96e97013f1
@ -6,4 +6,5 @@ openstackdocstheme>=1.18.1 # Apache-2.0
|
||||
os-api-ref>=1.4.0 # Apache-2.0
|
||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
||||
reno>=2.5.0 # Apache-2.0
|
||||
sphinxcontrib-apidoc>=0.2.0 # BSD
|
||||
sphinxcontrib-httpdomain>=1.3.0 # BSD
|
||||
|
@ -3,6 +3,6 @@
|
||||
===================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:maxdepth: 6
|
||||
|
||||
autoindex
|
||||
modules
|
||||
|
@ -77,6 +77,7 @@ extensions = ['sphinx.ext.autodoc',
|
||||
'sphinx.ext.coverage',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinx.ext.doctest',
|
||||
'sphinxcontrib.apidoc',
|
||||
'openstackdocstheme',
|
||||
'oslo_config.sphinxconfiggen',
|
||||
'oslo_policy.sphinxext',
|
||||
@ -155,6 +156,24 @@ primary_domain = 'py'
|
||||
nitpicky = False
|
||||
|
||||
|
||||
# -- Options for API documentation -------------------------------------------
|
||||
|
||||
apidoc_module_dir = '../../heat'
|
||||
apidoc_separate_modules = True
|
||||
apidoc_excluded_paths = [
|
||||
'testing',
|
||||
'cmd',
|
||||
'common',
|
||||
'cloudinit',
|
||||
'cfn_client',
|
||||
'doc',
|
||||
'db',
|
||||
'engine/resources',
|
||||
'locale',
|
||||
'tests',
|
||||
]
|
||||
|
||||
|
||||
# -- Options for HTML output --------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
|
19
setup.cfg
19
setup.cfg
@ -200,27 +200,10 @@ domain = heat
|
||||
output_dir = heat/locale
|
||||
input_file = heat/locale/heat.pot
|
||||
|
||||
[pbr]
|
||||
autodoc_index_modules = true
|
||||
autodoc_exclude_modules =
|
||||
heat.testing.*
|
||||
heat.cmd.*
|
||||
heat.common.*
|
||||
heat.cloudinit.*
|
||||
heat.cfn_client.*
|
||||
heat.doc.*
|
||||
heat.db.*
|
||||
heat.engine.resources.*
|
||||
heat.locale.*
|
||||
*.tests.*
|
||||
*.resources.*
|
||||
|
||||
[extract_messages]
|
||||
keywords = _ gettext ngettext l_ lazy_gettext
|
||||
mapping_file = babel.cfg
|
||||
output_file = heat/locale/heat.pot
|
||||
|
||||
[build_sphinx]
|
||||
all_files = 1
|
||||
build-dir = doc/build
|
||||
source-dir = doc/source
|
||||
warning-is-error = False
|
||||
|
Loading…
x
Reference in New Issue
Block a user