[openstack-dev] [docs] importing openstack-manuals questions, looking for strategies

Sean Dague sean at dague.net
Wed Aug 9 13:24:07 UTC 2017

On 08/09/2017 09:19 AM, Doug Hellmann wrote:
> Excerpts from Sean Dague's message of 2017-08-08 17:01:29 -0400:
>> When trying to import
>> https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/compute/hypervisor-vmware.rst#L2
>> into the Nova admin config reference
>> (https://review.openstack.org/#/c/491853), a couple of interesting
>> challenges popped up. These pop up in a couple of other places, but this
>> one file nicely contains both of them.
>> The first is the common autogenerated files (like
>> https://github.com/openstack/openstack-manuals/blob/6f9fc171800e8a435011f38cd4558e900884ce86/doc/config-reference/source/tables/nova-vmware.rst#L11).
>> To the best of my knowledge we don't have that autogeneration tooling in
>> the projects. Should we just be copy/pasting this content in? Is there
>> another better strategy there?
> oslo.config does have an extension for generating a table-format
> list of all of the configuration options, and the idea is to replace
> those included tables with the 'show-options' directive. It uses
> the same inputs as the sample file generator. See
> https://docs.openstack.org/oslo.config/latest/reference/sphinxext.html for
> details

So in this case we could:

.. show-options::


And that would have the same impact?


Sean Dague

More information about the OpenStack-dev mailing list