2d61baca21
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
12 lines
297 B
ReStructuredText
12 lines
297 B
ReStructuredText
=======================
|
|
Reference Documentation
|
|
=======================
|
|
|
|
Below you will find reference documentation for individual components of the JavaScript SDK. For
|
|
detailed, method-specific documentation, select the appropriate method below.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
jsdoc/Keystone
|