Open Stack

I have a little reservation about generating one project differently 
than the others, from a maintainability perspective.  Not that I'm 
against automating the documentation, but would it maybe make sense to 
have the script generate the WADL instead of the docs?  This way if we 
make changes to the docs themselves we don't have to change the 
Ceilometer script, because the docs will still be getting the WADL they 
expect.

----  Nick

On 11/28/2013 2:41 PM, Cyril Roelandt wrote:
> Hello !
>
> I recently wrote a Sphinx extension
> (https://github.com/stackforge/sphinxcontrib-docbookrestapi) that is
> used to generate the Ceilometer documentation for api.openstack.org
> (http://api.openstack.org/api-ref-metering.html). It should be
> integrated into Ceilometer soon enough
> (https://review.openstack.org/#/c/57978/ and
> https://review.openstack.org/#/c/57574/).
>
> Julien Danjou (CCed) proposed that we automatically generate this
> documentation. The idea would be to remove the WADL file from api-site,
> and replace it with a script that periodically checks out Ceilometer,
> runs the documentation generator, then pushes the generated files to
> api.openstack.org.
>
> Would you agree on making such a change ? If so, do you know how it
> could be done technically (which machine should run the script, for
> instance) ?
>
>
> Best regards,
> Cyril Roelandt.
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>