From 977b0c8591e40d3f59bbc1af9adc75f2c2edb694 Mon Sep 17 00:00:00 2001 From: Eric Fried Date: Tue, 22 Oct 2019 14:18:51 -0500 Subject: [PATCH] Use autoprogram-cliff for remaining plugin docs Sphinx errors have been fixed in the plugin projects for octavia, rsd, trove, watcher, and zun, so we can now use autoprogram-cliff to generate the docs for those. Change-Id: Ia7790c5e86957afd0aec8f9a04ffc7aa968b4eeb Story: #1735016 Task: #37241 --- doc/requirements.txt | 10 +++++----- doc/source/cli/plugin-commands/octavia.rst | 8 +------- doc/source/cli/plugin-commands/rsd.rst | 5 +---- doc/source/cli/plugin-commands/trove.rst | 5 +---- doc/source/cli/plugin-commands/watcher.rst | 8 +------- doc/source/cli/plugin-commands/zun.rst | 8 +------- doc/source/conf.py | 7 ++----- lower-constraints.txt | 10 +++++----- 8 files changed, 17 insertions(+), 44 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index d603c1d4b7..ec692e75a0 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -21,12 +21,12 @@ python-karborclient>=0.6.0 # Apache-2.0 python-mistralclient!=3.2.0,>=3.1.0 # Apache-2.0 python-muranoclient>=0.8.2 # Apache-2.0 python-neutronclient>=6.7.0 # Apache-2.0 -python-octaviaclient>=1.3.0 # Apache-2.0 -python-rsdclient>=0.1.0 # Apache-2.0 +python-octaviaclient>=1.11.0 # Apache-2.0 +python-rsdclient>=1.0.1 # Apache-2.0 python-saharaclient>=1.4.0 # Apache-2.0 python-searchlightclient>=1.0.0 #Apache-2.0 python-senlinclient>=1.1.0 # Apache-2.0 -python-troveclient>=2.2.0 # Apache-2.0 -python-watcherclient>=2.4.0 # Apache-2.0 +python-troveclient>=3.1.0 # Apache-2.0 +python-watcherclient>=2.5.0 # Apache-2.0 python-zaqarclient>=1.0.0 # Apache-2.0 -python-zunclient>=3.4.0 # Apache-2.0 +python-zunclient>=3.6.0 # Apache-2.0 diff --git a/doc/source/cli/plugin-commands/octavia.rst b/doc/source/cli/plugin-commands/octavia.rst index ce6259dd25..640af1ace8 100644 --- a/doc/source/cli/plugin-commands/octavia.rst +++ b/doc/source/cli/plugin-commands/octavia.rst @@ -1,10 +1,4 @@ octavia ------- -.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed - -For more details, see the :python-octaviaclient-doc:`python-octaviaclient -plugin documentation `. - -.. list-plugins:: openstack.load_balancer.v2 - :detailed: +.. autoprogram-cliff:: openstack.load_balancer.v2 diff --git a/doc/source/cli/plugin-commands/rsd.rst b/doc/source/cli/plugin-commands/rsd.rst index 9436c5ae75..d28cea316f 100644 --- a/doc/source/cli/plugin-commands/rsd.rst +++ b/doc/source/cli/plugin-commands/rsd.rst @@ -1,7 +1,4 @@ rsd --- -.. TODO(efried): Cut over to autoprogram-cliff once rsd plugin docs build - -.. list-plugins:: openstack.rsd.v1 - :detailed: +.. autoprogram-cliff:: openstack.rsd.v2 diff --git a/doc/source/cli/plugin-commands/trove.rst b/doc/source/cli/plugin-commands/trove.rst index 75da22726c..43560d4e2b 100644 --- a/doc/source/cli/plugin-commands/trove.rst +++ b/doc/source/cli/plugin-commands/trove.rst @@ -1,7 +1,4 @@ trove ----- -.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed - -.. list-plugins:: openstack.database.v1 - :detailed: +.. autoprogram-cliff:: openstack.database.v1 diff --git a/doc/source/cli/plugin-commands/watcher.rst b/doc/source/cli/plugin-commands/watcher.rst index c888d3a153..9cf6dfeea0 100644 --- a/doc/source/cli/plugin-commands/watcher.rst +++ b/doc/source/cli/plugin-commands/watcher.rst @@ -1,10 +1,4 @@ watcher ------- -.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed - -For more details, see the :python-watcherclient-doc:`python-watcherclient -plugin documentation `. - -.. list-plugins:: openstack.infra_optim.v1 - :detailed: +.. autoprogram-cliff:: openstack.infra_optim.v1 diff --git a/doc/source/cli/plugin-commands/zun.rst b/doc/source/cli/plugin-commands/zun.rst index 69f4f62c84..17baac557a 100644 --- a/doc/source/cli/plugin-commands/zun.rst +++ b/doc/source/cli/plugin-commands/zun.rst @@ -1,10 +1,4 @@ zun --- -.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed - -For more details, see the :python-zunclient-doc:`python-zunclient plugin -documentation `. - -.. list-plugins:: openstack.container.v1 - :detailed: +.. autoprogram-cliff:: openstack.container.v1 diff --git a/doc/source/conf.py b/doc/source/conf.py index 92febda46d..d3dfccd235 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -34,11 +34,8 @@ extensions = ['sphinx.ext.autodoc', repository_name = 'openstack/python-openstackclient' use_storyboard = True -openstack_projects = [ - 'python-octaviaclient', - 'python-watcherclient', - 'python-zunclient', -] +# Add project 'foo' to this list to enable the :foo-doc: role +# openstack_projects = [] # Add any paths that contain templates here, relative to this directory. #templates_path = ['_templates'] diff --git a/lower-constraints.txt b/lower-constraints.txt index 6533edafc3..201726ac65 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -101,17 +101,17 @@ python-mistralclient==3.1.0 python-muranoclient==0.8.2 python-neutronclient==6.7.0 python-novaclient==15.0.0 -python-octaviaclient==1.3.0 -python-rsdclient==0.1.0 +python-octaviaclient==1.11.0 +python-rsdclient==1.0.1 python-saharaclient==1.4.0 python-searchlightclient==1.0.0 python-senlinclient==1.1.0 python-subunit==1.0.0 python-swiftclient==3.2.0 -python-troveclient==2.2.0 -python-watcherclient==2.4.0 +python-troveclient==3.1.0 +python-watcherclient==2.5.0 python-zaqarclient==1.0.0 -python-zunclient==3.4.0 +python-zunclient==3.6.0 pytz==2013.6 PyYAML==3.12 repoze.lru==0.7