diff options
| author | michaeltchapman <woppin@gmail.com> | 2020-10-12 14:44:02 +1100 |
|---|---|---|
| committer | Michael Chapman <woppin@gmail.com> | 2020-10-13 12:52:46 +0000 |
| commit | 3648e2043ec7c0f8adb05f4ffa8a6acf5157145a (patch) | |
| tree | cd78c77d4f4d8197f2dde506d207f98e57805480 | |
| parent | 8f9c503ecc7f4fc8bd6cb2108256ba3e63bb3b73 (diff) | |
| download | python-designateclient-3648e2043ec7c0f8adb05f4ffa8a6acf5157145a.tar.gz | |
Fix doc reference builds
The api reference was broken some time around the stein release.
Moved conf options out of setup.cfg and into the doc conf.py, and added
an option to doc build to error on warnings so this doesn't happen
again without anyone noticing. The format is now similar to the
novaclient reference doc.
Change-Id: Ic9ed059521794acf1ac1a644096fdc10549fa91b
| -rw-r--r-- | doc/requirements.txt | 1 | ||||
| -rw-r--r-- | doc/source/conf.py | 15 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 3 | ||||
| -rw-r--r-- | setup.cfg | 7 | ||||
| -rw-r--r-- | tox.ini | 2 |
5 files changed, 18 insertions, 10 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index f2ab00e..73a167f 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -4,3 +4,4 @@ sphinx>=2.0.0,!=2.1.0 # BSD reno>=3.1.0 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0 +sphinxcontrib-apidoc>=0.2.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 351cb23..2f483c0 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -6,7 +6,11 @@ # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'openstackdocstheme'] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', + 'sphinxcontrib.apidoc', + 'openstackdocstheme'] # openstackdocstheme options openstackdocs_repo_name = 'openstack/python-designateclient' @@ -14,6 +18,15 @@ openstackdocs_bug_project = 'python-designateclient' openstackdocs_bug_tag = '' html_theme = 'openstackdocs' +apidoc_module_dir = '../../designateclient' +apidoc_output_dir = 'reference/api' +apidoc_excluded_paths = [ 'tests/*', 'functionaltests/*' ] +apidoc_separate_modules = True + +autodoc_exclude_modules = [ + 'designateclient.tests.*', + 'designateclient.functionaltests.*'] + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 331be17..a2def4e 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -3,5 +3,6 @@ ================================== .. toctree:: + :maxdepth: 4 - api/autoindex + api/modules @@ -117,10 +117,3 @@ input_file = designateclient/locale/designateclient.pot keywords = _ gettext ngettext l_ lazy_gettext mapping_file = babel.cfg output_file = designateclient/locale/designateclient.pot - -[pbr] -autodoc_index_modules = True -api_doc_dir = reference/api -autodoc_exclude_modules = - designateclient.tests.* - designateclient.functionaltests.* @@ -34,7 +34,7 @@ deps = -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} -r{toxinidir}/requirements.txt -r{toxinidir}/doc/requirements.txt -commands = sphinx-build -b html doc/source doc/build/html +commands = sphinx-build -W -b html doc/source doc/build/html [testenv:flake8] commands = flake8 |