diff options
| author | Ben Nemec <bnemec@redhat.com> | 2019-04-24 20:39:19 +0000 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2019-06-07 18:37:58 +0100 |
| commit | 96b84a90141add9a60153515daea95cfec2f8b53 (patch) | |
| tree | 645f828bacbca70554cd55a54c54f972aaf26ea5 /doc | |
| parent | e8e9da3d90d29aec71802f61c5270c3e5cf7cc90 (diff) | |
| download | pbr-96b84a90141add9a60153515daea95cfec2f8b53.tar.gz | |
Stop using pbr sphinx integration
Switch to sphinx-build directly and add sphinxcontrib-apidoc for
generated api docs.
Change-Id: I089a7695986892dcb47c5b5e79a6a227891a2347
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/requirements.txt | 1 | ||||
| -rw-r--r-- | doc/source/conf.py | 10 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 3 | ||||
| -rw-r--r-- | doc/source/user/history.rst | 5 | ||||
| -rw-r--r-- | doc/source/user/index.rst | 1 |
5 files changed, 11 insertions, 9 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 711fb97..d0c1f36 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,4 +1,5 @@ sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD +sphinxcontrib-apidoc>=0.2.0 # BSD openstackdocstheme>=1.18.1 # Apache-2.0 reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index cc7f4b3..13f63a0 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -8,7 +8,7 @@ sys.path.insert(0, os.path.abspath('../..')) # 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.todo'] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinxcontrib.apidoc'] # make openstackdocstheme optional to not increase the needed dependencies try: import openstackdocstheme @@ -72,3 +72,11 @@ latex_documents = [ '%s Documentation' % project, 'OpenStack Foundation', 'manual'), ] + +# -- sphinxcontrib.apidoc configuration -------------------------------------- + +apidoc_module_dir = '../../pbr' +apidoc_output_dir = 'reference/api' +apidoc_excluded_paths = [ + 'tests', +] diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 68a9c32..3162d67 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -3,6 +3,5 @@ =================== .. toctree:: - :glob: - api/* + api/modules diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst deleted file mode 100644 index 55439e7..0000000 --- a/doc/source/user/history.rst +++ /dev/null @@ -1,5 +0,0 @@ -================= - Release History -================= - -.. include:: ../../../ChangeLog diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 7854dc5..0629e2e 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -9,4 +9,3 @@ packagers semver compatibility - history |