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
25 lines
697 B
ReStructuredText
25 lines
697 B
ReStructuredText
========================
|
|
OpenStack JavaScript SDK
|
|
========================
|
|
|
|
Welcome to the OpenStack JavaScript SDK. This SDK is still under
|
|
construction, and many design decisions are being made. If you'd like to be
|
|
involved in this process, please take a look at the specifications and
|
|
patches under discussion in gerrit_, or come visit us in
|
|
`#openstack-javascript`_ on FreeNode (IRC).
|
|
|
|
Topics
|
|
======
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
getting_started
|
|
reference_documentation
|
|
dev_get_started
|
|
specs
|
|
|
|
|
|
.. _gerrit: https://review.openstack.org/#/q/status:open+AND+project:openstack/js-openstack-lib,n,z
|
|
.. _#openstack-javascript: http://webchat.freenode.net/?channels=openstack-javascript
|