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
This patch changes the `npm run doc` command to `npm run docs`.
I'm doing this because throughout infra, most of the job names use
'docs' as a short for 'documentation', and it's useful to remain
consistent.
Change-Id: I713ab3a076f97db92f4227b27486ec565c81ef83
> If the module name is not provided, it is derived from the module's path and filename.
So we'd better keep the path short but clear enough.
See: http://usejsdoc.org/tags-module.html
Change-Id: Id1a6069ddb82863e91adff14cec97299ab4a867f
run `npm run jsdoc` to generate api documentation in `jsdoc_build`
Change-Id: Ica8202a10b1d2c2a35453637f600501a71e412b7
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
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
gerrit project name shall come from
1. user answer if given
2. .gitreview if no answer is given
3. create from package name if .gitreview does not exist
Change-Id: I02eb9e86fd97fc67093e16a4264c24625f7f2e47
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
This library permits reading, validating, and accessing a set of
globally accepted dependency criteria. It will eventually be used
to synchronize dependencies across multiple javascript projects.
Change-Id: I2ec7a218311cfcfc7d33c4a1e29e73ed8e2f7b42
This patch accomplishes the following:
- It updates node security, as this depended on a version
of ansi-styles that was unpublished.
- It updates deprecated uses of yeoman Base and yeoman test.
- It adds mem-fs and mem-fs-editor to dependencies, as those are
only transiently available in later versions of node/npm.
In order to ensure that submodules can perform asynchronous actions,
we've wrapped their invocation into a Q-based promise chain. Thus,
each can either return the original generator, or may return a
promise that eventually resolves with that same generator.
Having multiple generators stopped being manageable very quickly.
This collapses it all, and ensures tests still pass.
Also, this includes istanbul exclusions.
This file was created by the generator-generator. Now that the
default generator does something a little more useful, there's no
need to keep it around.
This patch removes gulp, and moves commands such as nsp and test
execution directly into package.json. Coverage threshold tests via
istanbul have also been added.
Andreas Jaeger