977c1c06dc
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
generator-openstack
generator-openstack is OpenStack's JavaScript project templating and maintenance engine. It permits you to:
- ...create a new OpenStack JavaScript project.
- ...update an existing project with new settings, requirements, and tools.
Quick Start
Creating and updating a project follows the exact same steps:
- Prerequisites:
nodejs,npm npm install -g yo generator-openstackcd my_project_directoryyo openstack
The generator also provides a non-interactive mode: yo openstack --non-interactive
Contributing
This project uses itself as a code management tool. In order to set up your environment for development, please follow these steps:
- Prerequisites:
nodejs,npm,git,git review npm install -g yogit clone git://git.openstack.org/openstack/js-generator-openstackcd js-generator-openstacknpm installgit review -s
This should set up your project directory and make it ready for development.
Some useful development commands
npm link- Link this project into your global npm runtime. This allows you to run the project (viayo openstack) as if it was installed vianpm install -gnpm test- Run all the tests.npm run lint- Perform a linting check.
TODO List
Looking for something to add? Please check StoryBoard
Project Resources
- Source code
- Code review
- Task tracking (StoryBoard)
- Discussion on openstack develop mailing list with tag
[javascript] - IRC:
#openstack-javascripton freenode.net