openstack/python-openstackclient
Code Issues Proposed changes
fcae62841f
python-openstackclient/doc/source/cli/plugin-commands/zun.rst

11 lines
246 B
ReStructuredText
Raw Normal View History

Split plugin docs per project Once [1] fixed plugin doc generation, the (single) page it produced was unusably huge. This commit splits it into one page per project. Note that there are four plugin projects that didn't have sections included: - cue - murano - tripleo - watcher These were noted in hidden rst which is preserved in the (new) index page. [1] Id9be39971110fd2eb4519a0582c9bf2514cdcacd Change-Id: I0214ddb00a5a292a46d7cfb539d6dcc540fdae79 Story: #1735016 Task: #37239
2019-10-21 17:05:57 -05:00
zun
---
Produce complete content for plugin docs Plugin documentation previously used ``.. list-plugins::`` for each plugin command, which just produced the summary line. This might be useful if there were also a link to the complete (per-project) docs for the commands; but since we have the content available, we might as well produce the complete plugin docs inline. That's going to be most useful to a reader anyway. So this commit switches from ``list-plugins`` to ``autoprogram-cliff`` -- except for the following, whose docs break the build when this is done: - octavia - rsd - trove - zun These fixups are tracked under task #37241 under this same story. Change-Id: I2f17e203fe3da92a709884c9052c8e39ff87f4c8 Story: #1735016 Task: #37240
2019-10-21 17:31:04 -05:00
.. TODO(efried): cut over to autoprogram-cliff once doc build is fixed
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
2019-10-22 08:08:28 -05:00
For more details, see the :python-zunclient-doc:`python-zunclient plugin
documentation </cli/command-list>`.
Split plugin docs per project Once [1] fixed plugin doc generation, the (single) page it produced was unusably huge. This commit splits it into one page per project. Note that there are four plugin projects that didn't have sections included: - cue - murano - tripleo - watcher These were noted in hidden rst which is preserved in the (new) index page. [1] Id9be39971110fd2eb4519a0582c9bf2514cdcacd Change-Id: I0214ddb00a5a292a46d7cfb539d6dcc540fdae79 Story: #1735016 Task: #37239
2019-10-21 17:05:57 -05:00
.. list-plugins:: openstack.container.v1
:detailed:
Copy Permalink