x/js-generator-openstack
Code Issues Proposed changes
Files
c2cc0eac5deee5887535fe59786e647732cfff84
js-generator-openstack/doc/source/index.rst
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

1.4 KiB
Raw Blame History

OpenStack Yeoman Generator

Welcome to the documentation for the OpenStack Yeoman Project Generator. This project allows you to create a new OpenStack JavaScript project, and update an existing project with new settings, dependencies, and tools.

Quickstart

If you'd just like to create a new project, you can do so quickly and easily with the following steps:

npm install -g yo generator-openstack

cd my_project_directory

yo openstack

From here, you'll be asked a few basic questions about your new project, and once completed, your project will be ready to go!

Contributing

There are several quick and easy ways that you can contribute to this project:

  1. File Bugs on StoryBoard.
  2. Chat on IRC in #openstack-javascript.
  3. Review code on gerrit.

If you'd like to contribute code, and for more information on project tooling, conventions, and setup, please see our ./development_guide.

Topics

development_guide specs reference_documentation