Chrome is required for testing. It would be good to manage it with
bindep as well as firefox and xvfb.
Change-Id: Ide439f58ebacd4441af9f14e5a26f29b306280cc
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
Add a bindep.txt file containing a cross-platform list
of dependencies needed for running included non-devstack tests.
This change is needed since the infra team will not install standard
packages in jobs anymore, projects should use other-requirements.txt
instead. The macros xvfb-install, firefox-install, chrome-install
which are used to run some jobs for this repository will be removed
soon.
This change is self-testing.
For bindep.txt see also
http://docs.openstack.org/infra/manual/drivers.html#package-requirements
[*] http://docs.openstack.org/infra/bindep/
Depends-On: I6d3491c1ee18c579c768ae931a5edb2b783a19a3
Change-Id: If053677bb48898cf56001e6648605b5420567417
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
- remove Eslint from function names since it is redudant in module
- rename `eslintrc` to `rcContent` to keep consistent with `rcFile`
Change-Id: I616e551fc5752e6d61d96f91da556825071d4316
> 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>
It is not required by node.js, but introduce troubles while
generating documents with jsdoc3.
Refer to https://github.com/jsdoc3/jsdoc/issues/456
Change-Id: I6664f1be0fc3e86f3a7e3843d557786c37df1c5e
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