diff options
| author | Eric Fried <openstack@fried.cc> | 2019-10-22 08:08:28 -0500 |
|---|---|---|
| committer | Eric Fried <openstack@fried.cc> | 2019-10-22 10:27:24 -0500 |
| commit | fcae62841f9a0ddc70a7e5be5202eea379378d70 (patch) | |
| tree | 91eaba907a719935f44a68b8911c595e32eba014 /doc/source/cli/plugin-commands | |
| parent | 67a5654d4977998c8c767e2d5c595fba5b12164f (diff) | |
| download | python-openstackclient-fcae62841f9a0ddc70a7e5be5202eea379378d70.tar.gz | |
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
Diffstat (limited to 'doc/source/cli/plugin-commands')
| -rw-r--r-- | doc/source/cli/plugin-commands/octavia.rst | 3 | ||||
| -rw-r--r-- | doc/source/cli/plugin-commands/watcher.rst | 3 | ||||
| -rw-r--r-- | doc/source/cli/plugin-commands/zun.rst | 3 |
3 files changed, 9 insertions, 0 deletions
diff --git a/doc/source/cli/plugin-commands/octavia.rst b/doc/source/cli/plugin-commands/octavia.rst index fb48f0ac..ce6259dd 100644 --- a/doc/source/cli/plugin-commands/octavia.rst +++ b/doc/source/cli/plugin-commands/octavia.rst @@ -3,5 +3,8 @@ 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 </cli/index>`. + .. list-plugins:: openstack.load_balancer.v2 :detailed: diff --git a/doc/source/cli/plugin-commands/watcher.rst b/doc/source/cli/plugin-commands/watcher.rst index 7f9afbdc..c888d3a1 100644 --- a/doc/source/cli/plugin-commands/watcher.rst +++ b/doc/source/cli/plugin-commands/watcher.rst @@ -3,5 +3,8 @@ 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 </cli/openstack_cli>`. + .. list-plugins:: openstack.infra_optim.v1 :detailed: diff --git a/doc/source/cli/plugin-commands/zun.rst b/doc/source/cli/plugin-commands/zun.rst index 40480e70..69f4f62c 100644 --- a/doc/source/cli/plugin-commands/zun.rst +++ b/doc/source/cli/plugin-commands/zun.rst @@ -3,5 +3,8 @@ 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 </cli/command-list>`. + .. list-plugins:: openstack.container.v1 :detailed: |