[docs] Documenting CLI references (openstack-auto-commands)

Sean McGinnis sean.mcginnis at gmx.com
Fri Apr 19 19:26:36 UTC 2019


On Fri, Apr 19, 2019 at 08:20:56PM +0300, Andrey Kurilin wrote:
> Hi Seam!
>
> Rally CLI is implemented on top of argparse library. Our CLI looks like
> `rally <category> <command>`.
> As for documentation, I wrote a sphinx extension for auto-constructing CLI
> references.
> It contains some rally-specific stuff, but not too much. Maybe, it can be
> helpful for you.
>
> Refs:
> 1) extension itself:
> https://github.com/openstack/rally/blob/1.4.1/doc/ext/cli_reference.py
> 2) place to display cli ref:
> https://raw.githubusercontent.com/openstack/rally/1.4.1/doc/source/cli_reference.rst
> 3) result at rtd: https://rally.readthedocs.io/en/latest/cli_reference.html
> 4) result at docs.o.o using an old openstack theme -
> https://docs.openstack.org/rally/latest/cli_reference.html
>

This looks very useful. Thanks Andrey!



More information about the openstack-discuss mailing list