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/conf.py | |
| 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/conf.py')
| -rw-r--r-- | doc/source/conf.py | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 45045002..92febda4 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'] |
