js-openstack-lib/doc
Michael Krotscheck 2d61baca21 Added jsdoc3 output to doc generation
This patch adds jsdoc3-generated documentation to our docs build.
It does so by using publicly available sphinx.rst templates, writing
them into a .gitignore'd folder in the docs directory, and providing
references to these autogenerated documents in our own site.

There are some notable bugs:
- jsdoc-sphinx templates do not honor @ignore and @private
- jsdoc-sphinx templates do not ignore private variables (listed under
  members at the bottom).
- jsdoc-sphinx templates add superfluous 'Children' section to the
  top as subsection navigation.

It would make quite a bit of sense for us to contribute to
jsdoc-sphinx so that the above mentioned bugs are resolved. However,
as some documentation is better than no documentation, right now this
is fine.

Change-Id: I2905358a6410d5dace96c25dc57dda100fae4b48
2016-08-30 14:26:10 -07:00
..
source Added jsdoc3 output to doc generation 2016-08-30 14:26:10 -07:00
Makefile Added Sphinx-based documentation framework and specs repo. 2016-06-23 06:55:17 -07:00