On 22/11/17 20:04, Graham Hayes wrote:
<snip> > When I was talking to Gil about it, I suggested writing a new sphinx / > docutils formatter. I am not sure how feasible it would be, but it could > be possible (as sphinx has the whole page tree in memory when writing it > out, we may be able to output it in some sort of structured format. > > I would be hesitant to change how we write docs - this change took long > enough to get in place, and the ability to add / remove bits to suit > different projects is a good thing. Pages like [1] would be hard to do > in a standard machine readable format, and I think they definitely make > the docs better. > > - Graham > > 1 - https://developer.openstack.org/api-ref/compute/#servers-servers > > Ok, I have done a quick (read: very rough and hacky) prototype of the formatter here [1] It uses the sphinx formatter plugin system, and reads from what we already have in the api-ref/* folder. It outputs [2] yaml that describes each endpoint, and the fields in the request / response. If there is interest, I can clean up the patch, and look at supporting microversions. 1 - https://review.openstack.org/#/c/528801/ 2 - http://paste.openstack.org/show/629241/ - Graham > > __________________________________________________________________________ > OpenStack Development Mailing List (not for usage questions) > Unsubscribe: [email protected]?subject:unsubscribe > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev >
signature.asc
Description: OpenPGP digital signature
__________________________________________________________________________ OpenStack Development Mailing List (not for usage questions) Unsubscribe: [email protected]?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
