Commit Graph

3 Commits

Author SHA1 Message Date
Andreas Jaeger f57ebca959 Retire js-generator-openstack
This repository is unused, retire it.

Change-Id: Ib6b55e118b7092a05dfe6bcbb6bcb66a8b20fdc2
Depends-On: https://review.openstack.org/597370/
2018-08-29 09:04:51 +02:00
Michael Krotscheck 977c1c06dc 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: Ie7503f4874c8b4bbb4bb4926cddc578d59ce0613
2016-08-24 09:59:22 +08:00
Michael Krotscheck bb0a83f300 Added Sphinx-based documentation framework and specs repo.
All of ospenstack'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: I95afbc7001643a3564961c3b5326df4b35c29be8
2016-06-17 12:58:42 -07:00