From fcae62841f9a0ddc70a7e5be5202eea379378d70 Mon Sep 17 00:00:00 2001
From: Eric Fried <openstack@fried.cc>
Date: Tue, 22 Oct 2019 08:08:28 -0500
Subject: [PATCH] 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
---
 doc/source/cli/plugin-commands/octavia.rst | 3 +++
 doc/source/cli/plugin-commands/watcher.rst | 3 +++
 doc/source/cli/plugin-commands/zun.rst     | 3 +++
 doc/source/conf.py                         | 6 ++++++
 4 files changed, 15 insertions(+)

diff --git a/doc/source/cli/plugin-commands/octavia.rst b/doc/source/cli/plugin-commands/octavia.rst
index fb48f0ac7e..ce6259dd25 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 7f9afbdc26..c888d3a153 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 40480e70ca..69f4f62c84 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:
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 45045002aa..92febda46d 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -34,6 +34,12 @@ extensions = ['sphinx.ext.autodoc',
 repository_name = 'openstack/python-openstackclient'
 use_storyboard = True
 
+openstack_projects = [
+    'python-octaviaclient',
+    'python-watcherclient',
+    'python-zunclient',
+]
+
 # Add any paths that contain templates here, relative to this directory.
 #templates_path = ['_templates']