[openstack-dev] [ironic] API docs now publishing from our tree

Ruby Loo opensrloo at gmail.com
Wed May 4 21:22:05 UTC 2016

Sweet. Thanks Jim (and everyone else that made this happen).

I do want to make sure there is one "source of truth" to the API
documentation. We are already generating REST API documentation at
http://docs.openstack.org/developer/ironic/webapi/v1.html. The info for
this comes from docstrings etc in our code files.

To make it easier and so that documentation doesn't get out of sync, I
don't really want people to have to remember to update the code/docstrings
as well as the new files that were added to generate this new api-ref


On Wed, May 4, 2016 at 5:10 PM, Jim Rollenhagen <jim at jimrollenhagen.com>

> Hey y'all,
> I did the push this week to move the api-ref into our tree, and it's now
> publishing. \o/
> The docs are here: http://developer.openstack.org/api-ref/baremetal/
> The source is here:
> http://git.openstack.org/cgit/openstack/ironic/tree/api-ref/source
> I know devananda is doing a push to update some things there. If you'd
> like to help clean up and improve our docs, please sync with him. They
> need a lot of love, so all help is welcome. :)
> // jim
> __________________________________________________________________________
> 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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20160504/efefcb1b/attachment.html>

More information about the OpenStack-dev mailing list