As we will upload documentation to developer.openstack.org, this
patch switch sphinx template from 'osloshpinx' to
'openstackdocstheme'
Change-Id: I8073e72c11117ec605dcc8441a0c091f030014f8
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
This specification describes what needs to be done for a proper
devstack-gate test, as well as how we interact with third-party CI.
Change-Id: If491e1200c92d38c105e5d7a736c23c6577f44bc
This spec describes the approach of interaction with OpenStack
API which should be used by the library.
Change-Id: Iedc85d5bb2518b4099177d6db31abddbabafa03b
All of openstack's documentation infrastructure is run via sphinx, including
templates, html parsing, uploading, and more. Thus it behooves us to keep
our javascript documentation build as similar as possible. Since we want to
avoid using tox, and littering the project with pythonic artifacts, we're
instead using Sphinx' own recommended build method: A Makefile.
This patch adds a small but complete documentation tree for this project,
including the build tools needed to create it. It satisfies the need for
narrative documentation, but does not (yet) satisfy the need for code
doc generation. It also includes a section for specifications, as this
effort is not yet large enough to warrant its own specification repo.
Code documentation will need to be added in a subsequent patch, using
Sphinx' jsdoc plugins.
Change-Id: I40eab962d4e4c6eafd1b1499bb00e6af5d72ede0
ricolin