Skip to content

Commit fcae628

Browse files
author
Eric Fried
committed
Link to (some) plugin doc pages
We would like to use autoprogram-cliff to generate full docs inline for each plugin. But for the following projects, that breaks the build: - octavia - rsd - trove - watcher - zun For those projects, we're using list-plugins instead, because that builds, and it's better than nothing; but it only provides summaries of the commands. So with this commit, we add a link to the plugin documentation from the actual plugin project where such documentation exists, which currently is just: - octavia - watcher - zun (For rsd, I couldn't find openstack-published docs at all; for trove, published docs exist, but the osc plugin isn't documented.) Change-Id: I7c826ecef4319bead239e11b5f975302b2f24d1b Story: #1735016 Task: #37244
1 parent 67a5654 commit fcae628

4 files changed

Lines changed: 15 additions & 0 deletions

File tree

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,8 @@ octavia
33

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

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,8 @@ watcher
33

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

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,8 @@ zun
33

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

doc/source/conf.py

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

37+
openstack_projects = [
38+
'python-octaviaclient',
39+
'python-watcherclient',
40+
'python-zunclient',
41+
]
42+
3743
# Add any paths that contain templates here, relative to this directory.
3844
#templates_path = ['_templates']
3945

0 commit comments

Comments
 (0)