Merge "Added jsdoc3 output to doc generation"

This commit is contained in:
Jenkins
2016-09-07 12:14:41 +00:00
committed by Gerrit Code Review
4 changed files with 18 additions and 3 deletions

2
.gitignore vendored
View File

@@ -19,4 +19,4 @@ pids
reports
www
doc/build
jsdoc_build
doc/source/jsdoc

View File

@@ -43,6 +43,8 @@ Topics
development_guide
specs
reference_documentation
.. _StoryBoard: https://storyboard.openstack.org/#!/project/842
.. _gerrit: https://review.openstack.org/#/q/status:open+AND+project:openstack/js-generator-openstack,n,z

View File

@@ -0,0 +1,12 @@
=======================
Reference Documentation
=======================
Below you will find reference documentation for individual components of the generator. For
detailed, method-specific documentation, select the appropriate method below.
.. toctree::
:maxdepth: 2
:glob:
jsdoc/module-*

View File

@@ -9,8 +9,8 @@
"posttest": "istanbul check-coverage",
"prepublish": "nsp check",
"lint": "eslint ./",
"docs": "(cd doc; make html)",
"jsdoc": "jsdoc generators/app/lib -r -d jsdoc_build"
"docs": "npm run jsdoc; (cd doc; make html)",
"jsdoc": "jsdoc -t node_modules/jsdoc-sphinx/template -r -d ./doc/source/jsdoc ./generators/app/lib"
},
"keywords": [
"yeoman-generator",
@@ -36,6 +36,7 @@
"istanbul": "^0.4.2",
"jasmine": "^2.4.1",
"jsdoc": "^3.4.0",
"jsdoc-sphinx": "0.0.6",
"karma": "^0.13.22",
"karma-htmlfile-reporter": "^0.2.2",
"mem-fs": "^1.1.2",