[openstack-dev] [api] [docs] [cinder] [swift] [glance] [keystone] [ironic] [trove] [neutron] [heat] [senlin] [manila] [sahara] RST + YAML files ready for pick up from WADL migration

Jim Rollenhagen jim at jimrollenhagen.com
Tue May 3 17:41:27 UTC 2016

On Tue, May 03, 2016 at 08:29:16AM -0500, Anne Gentle wrote:
> Hi all,
> This patch contains all the RST + YAML for projects to bring over to their
> repos to begin building API reference information from within your repo.
> Get a copy of this patch, and pick up the files for your service in
> api-site/api-ref/source/<service>:
> https://review.openstack.org/#/c/311596/
> There is required cleanup, and you'll need an index.rst, conf.py, and build
> jobs. All of these can be patterned after the nova repository api-ref
> directory.
> http://docs.openstack.org/contributor-guide/api-guides.html
> It's overall in good shape thanks to Karen Bradshaw, Auggy Ragwitz, Andreas
> Jaeger, and Sean Dague. Appreciate the help over the finish line during
> Summit week, y'all.
> The api-site/api-ref files are now frozen and we will not accept patches.
> The output at developer.openstack.org/api-ref.html remains frozen until we
> can provide redirects to the newly-sourced-and-built files. Please, make
> this work a priority in this release. Ideally we can get everyone ready by
> Milestone 1 (May 31).
> If you would like to use a Swagger/OpenAPI file, pick that file up from
> developer.openstack.org/draft/swagger/ and create build jobs from your repo
> to publish it on developer.openstack.org.
> Let me know if you have questions.
> Thanks,
> Anne

Thanks for doing this, Anne!

Don't forget to add an api-ref tox target, a la

This is necessary for the jobs to do anything.

// jim

> -- 
> Anne Gentle
> www.justwriteclick.com

> __________________________________________________________________________
> 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

More information about the OpenStack-dev mailing list