Skip to content

Commit 977b0c8

Browse files
author
Eric Fried
committed
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
1 parent fcae628 commit 977b0c8

File tree

8 files changed

+17
-44
lines changed

8 files changed

+17
-44
lines changed

‎doc/requirements.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ python-karborclient>=0.6.0 # Apache-2.0
2121
python-mistralclient!=3.2.0,>=3.1.0 # Apache-2.0
2222
python-muranoclient>=0.8.2 # Apache-2.0
2323
python-neutronclient>=6.7.0 # Apache-2.0
24-
python-octaviaclient>=1.3.0 # Apache-2.0
25-
python-rsdclient>=0.1.0 # Apache-2.0
24+
python-octaviaclient>=1.11.0 # Apache-2.0
25+
python-rsdclient>=1.0.1 # Apache-2.0
2626
python-saharaclient>=1.4.0 # Apache-2.0
2727
python-searchlightclient>=1.0.0 #Apache-2.0
2828
python-senlinclient>=1.1.0 # Apache-2.0
29-
python-troveclient>=2.2.0 # Apache-2.0
30-
python-watcherclient>=2.4.0 # Apache-2.0
29+
python-troveclient>=3.1.0 # Apache-2.0
30+
python-watcherclient>=2.5.0 # Apache-2.0
3131
python-zaqarclient>=1.0.0 # Apache-2.0
32-
python-zunclient>=3.4.0 # Apache-2.0
32+
python-zunclient>=3.6.0 # Apache-2.0

‎doc/source/cli/plugin-commands/octavia.rst‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
11
octavia
22
-------
33

4-
.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed
5-
6-
For more details, see the :python-octaviaclient-doc:`python-octaviaclient
7-
plugin documentation </cli/index>`.
8-
9-
.. list-plugins:: openstack.load_balancer.v2
10-
:detailed:
4+
.. autoprogram-cliff:: openstack.load_balancer.v2

‎doc/source/cli/plugin-commands/rsd.rst‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
rsd
22
---
33

4-
.. TODO(efried): Cut over to autoprogram-cliff once rsd plugin docs build
5-
6-
.. list-plugins:: openstack.rsd.v1
7-
:detailed:
4+
.. autoprogram-cliff:: openstack.rsd.v2

‎doc/source/cli/plugin-commands/trove.rst‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
trove
22
-----
33

4-
.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed
5-
6-
.. list-plugins:: openstack.database.v1
7-
:detailed:
4+
.. autoprogram-cliff:: openstack.database.v1

‎doc/source/cli/plugin-commands/watcher.rst‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
11
watcher
22
-------
33

4-
.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed
5-
6-
For more details, see the :python-watcherclient-doc:`python-watcherclient
7-
plugin documentation </cli/openstack_cli>`.
8-
9-
.. list-plugins:: openstack.infra_optim.v1
10-
:detailed:
4+
.. autoprogram-cliff:: openstack.infra_optim.v1

‎doc/source/cli/plugin-commands/zun.rst‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
11
zun
22
---
33

4-
.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed
5-
6-
For more details, see the :python-zunclient-doc:`python-zunclient plugin
7-
documentation </cli/command-list>`.
8-
9-
.. list-plugins:: openstack.container.v1
10-
:detailed:
4+
.. autoprogram-cliff:: openstack.container.v1

‎doc/source/conf.py‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,8 @@
3434
repository_name = 'openstack/python-openstackclient'
3535
use_storyboard = True
3636

37-
openstack_projects = [
38-
'python-octaviaclient',
39-
'python-watcherclient',
40-
'python-zunclient',
41-
]
37+
# Add project 'foo' to this list to enable the :foo-doc: role
38+
# openstack_projects = []
4239

4340
# Add any paths that contain templates here, relative to this directory.
4441
#templates_path = ['_templates']

‎lower-constraints.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,17 +101,17 @@ python-mistralclient==3.1.0
101101
python-muranoclient==0.8.2
102102
python-neutronclient==6.7.0
103103
python-novaclient==15.0.0
104-
python-octaviaclient==1.3.0
105-
python-rsdclient==0.1.0
104+
python-octaviaclient==1.11.0
105+
python-rsdclient==1.0.1
106106
python-saharaclient==1.4.0
107107
python-searchlightclient==1.0.0
108108
python-senlinclient==1.1.0
109109
python-subunit==1.0.0
110110
python-swiftclient==3.2.0
111-
python-troveclient==2.2.0
112-
python-watcherclient==2.4.0
111+
python-troveclient==3.1.0
112+
python-watcherclient==2.5.0
113113
python-zaqarclient==1.0.0
114-
python-zunclient==3.4.0
114+
python-zunclient==3.6.0
115115
pytz==2013.6
116116
PyYAML==3.12
117117
repoze.lru==0.7

0 commit comments

Comments
 (0)