[openstack-dev] [javascript] library api reference publishing

Yujun Zhang zhangyujun+zte at gmail.com
Wed Aug 17 02:42:04 UTC 2016

As an action from the javascript meeting, below is the summary of how to
integrate jsdoc [1] generated api reference with sphinx document.

Feel free to comment and discuss in today's meeting.

   - findings

   - openstack api ref is dedicated to describe RESTful interface

   - no example of library api reference found

   - Proposal

   - hosting api reference on independent site and add external link in
   openstack document site

   - api reference: http://js-generator-openstack.openzero.net/

   - infra document: http://docs.openstack.org/infra/

   - TODO

   - hosting of api reference (static HTML pages)

   - github pages?

   - publish api reference with CI

[1] http://usejsdoc.org/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20160817/0970071a/attachment.html>

More information about the OpenStack-dev mailing list