ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2024-12-18 20:57:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[Documentation] Changed build script to produce new API docs for website. Fixes #1249t

Browse Source
This commit is contained in:
Henry 2016-10-13 15:36:59 -07:00
parent 3e6c9fa318
commit a2711c2c08
3 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
build-docs.sh
View File

@ -24,7 +24,7 @@
# Script to build and deploy docs. # Script to build and deploy docs.
OUTPUT_DIRECTORY="target/docs" OUTPUT_DIRECTORY="dist/docs"
# Docs, once built, are pushed to the private website repo # Docs, once built, are pushed to the private website repo
REPOSITORY_URL="git@github.com:nasa/openmct-website.git" REPOSITORY_URL="git@github.com:nasa/openmct-website.git"
WEBSITE_DIRECTORY="website" WEBSITE_DIRECTORY="website"

3
docs/src/index.md
View File

@ -34,5 +34,4 @@ As we transition to a new API, the following documentation for the old API
platform and the functionality that it provides. platform and the functionality that it provides.
* The [Tutorials](tutorials/) give examples of extending the platform to add * The [Tutorials](tutorials/) give examples of extending the platform to add
functionality, functionality, and integrate with data sources.
and integrate with data sources.

2
package.json
View File

@ -49,7 +49,7 @@
"jshint": "jshint platform example", "jshint": "jshint platform example",
"watch": "karma start", "watch": "karma start",
"jsdoc": "jsdoc -c jsdoc.json -R API.md -r -d dist/docs/api", "jsdoc": "jsdoc -c jsdoc.json -R API.md -r -d dist/docs/api",
"otherdoc": "node docs/gendocs.js --in docs/src --out target/docs --suppress-toc 'docs/src/index.md|docs/src/process/index.md'", "otherdoc": "node docs/gendocs.js --in docs/src --out dist/docs --suppress-toc 'docs/src/index.md|docs/src/process/index.md'",
"docs": "npm run jsdoc ; npm run otherdoc", "docs": "npm run jsdoc ; npm run otherdoc",
"prepublish": "node ./node_modules/bower/bin/bower install && node ./node_modules/gulp/bin/gulp.js install" "prepublish": "node ./node_modules/bower/bin/bower install && node ./node_modules/gulp/bin/gulp.js install"
}, },