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
   http://developer.openstack.org/api-ref.html


   - 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/
__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Reply via email to