[openstack-dev] [oslo][nova] Anyone interested in writing a policy generator sphinx extension?

Matt Riedemann mriedem at linux.vnet.ibm.com
Sun Oct 23 22:50:15 UTC 2016


On 9/26/2016 8:48 AM, Stephen Finucane wrote:
> On Wed, 2016-09-21 at 11:16 -0400, Doug Hellmann wrote:
>> Excerpts from Matt Riedemann's message of 2016-09-21 09:49:29 -0500:
>>>
>>> Nova has policy defaults in code now and we can generate the
>>> sample
>>> using oslopolicy-sample-generator but we'd like to get the default
>>> policy sample in the Nova developer documentation also, like we
>>> have for
>>> nova.conf.sample.
>>>
>>> I see we use the sphinxconfiggen extension for building the
>>> nova.conf.sample in our docs, but I don't see anything like that
>>> for
>>> generating docs for a sample policy file.
>>>
>>> Has anyone already started working on that, or is interested in
>>> working
>>> on that? I've never written a sphinx extension before but I'm
>>> guessing
>>> it could be borrowed a bit from how sphinxconfiggen was written in
>>> oslo.config.
>>>
>>
>> I don't have time to do it myself, but I can help get someone else
>> started and work with them on code reviews in oslo.policy.
>
> I can take a look at this, though I'll only persue a "sphinxpolicygen"
> module for now (we don't use oslo_config's "sphinxext" module yet).
>
> Stephen
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>

Just to circle back on progress here, Stephen got things done and 
results can be seen here:

http://docs.openstack.org/developer/nova/sample_policy.html

-- 

Thanks,

Matt Riedemann




More information about the OpenStack-dev mailing list