<div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div>Hi Seam!</div><div><br></div><div></div><div>Rally CLI is implemented on top of argparse library. Our CLI looks like `rally <category> <command>`.</div><div>As for documentation, I wrote a sphinx extension for auto-constructing CLI references. <br></div><div>It contains some rally-specific stuff, but not too much. Maybe, it can be helpful for you.<br></div><div><br></div><div>Refs:<br></div><div>1) extension itself: <a href="https://github.com/openstack/rally/blob/1.4.1/doc/ext/cli_reference.py">https://github.com/openstack/rally/blob/1.4.1/doc/ext/cli_reference.py</a></div><div>2) place to display cli ref: <a href="https://raw.githubusercontent.com/openstack/rally/1.4.1/doc/source/cli_reference.rst">https://raw.githubusercontent.com/openstack/rally/1.4.1/doc/source/cli_reference.rst</a></div>3) result at rtd: <a href="https://rally.readthedocs.io/en/latest/cli_reference.html">https://rally.readthedocs.io/en/latest/cli_reference.html</a></div><div>4) result at docs.o.o using an old openstack theme - <a href="https://docs.openstack.org/rally/latest/cli_reference.html">https://docs.openstack.org/rally/latest/cli_reference.html</a><br></div></div></div></div></div></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">пт, 19 апр. 2019 г. в 01:01, Sean McGinnis <<a href="mailto:sean.mcginnis@gmx.com">sean.mcginnis@gmx.com</a>>:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hey everyone,<br>
<br>
Hoping someone has discussed this and has a recommended course of action.<br>
<br>
Back when we had the awesome support of the openstack-docs team, there was a<br>
command called openstack-auto-commands that would load up client commands and<br>
generate help output for all commands. With the resource constraints that hit<br>
the team, there were less folks to support tools like this. Docs moved into<br>
each team's repos and, for the most part, I think that has worked out well.<br>
<br>
Some of the automatic syncing stopped happening with this move to in-repo docs.<br>
One of them was CLI docs. But it would appear there are at least a few teams<br>
that now have not updated these docs since that move happened several releases<br>
ago:<br>
<br>
<a href="http://codesearch.openstack.org/?q=This%20file%20is%20tool-generated&i=nope&files=&repos=" rel="noreferrer" target="_blank">http://codesearch.openstack.org/?q=This%20file%20is%20tool-generated&i=nope&files=&repos=</a><br>
<br>
There are others that appear to have used the last automatically generated<br>
version and have been (varying degrees of) successful at just manually updating<br>
the doc as things change.<br>
<br>
When the tool was removed (<a href="https://review.openstack.org/#/c/509402/" rel="noreferrer" target="_blank">https://review.openstack.org/#/c/509402/</a>) it was<br>
stated that it wasn't needed because cliff has sphinx integration to do the<br>
equivalent automatically. That's all well and good... if you are using cliff.<br>
But I think many of our legacy clients are not.<br>
<br>
So looking for recommendations on ways to best keep these docs up to date now.<br>
Migrate to cliff? Other in-repo automation tools?<br>
<br>
(and yeah, I know, "drop the CLI and move to openstackclient)<br>
<br>
Thanks for any suggestions!<br>
<br>
Sean<br>
<br>
</blockquote></div><br clear="all"><br>-- <br><div dir="ltr" class="gmail_signature"><div dir="ltr">Best regards,<br>Andrey Kurilin.<br></div></div>