[Docs] remove dependencies for building docs

Remove depencendies necessary to build docs from package.json and
specify them in the readme.  Due to difficulty managing dependencies
for nomnoml on different platforms, this reduces dependency requirements
to only those needed for building the package.
This commit is contained in:
Pete Richards 2016-01-15 10:48:48 -08:00
parent 193c7e3db2
commit 6fc028e112
3 changed files with 8 additions and 10 deletions

View File

@ -99,17 +99,16 @@ Run as `mvn clean install`.
### Building Documentation
Open MCT Web's documentation is generated by an
[npm](https://www.npmjs.com/)-based build:
[npm](https://www.npmjs.com/)-based build. It has additional dependencies that
may not be available on every platform and thus is not covered in the standard
npm install. Ensure your system has [libcairo](http://cairographics.org/)
installed and then run the following commands:
* `npm install` _(only needs to run once)_
* `npm install`
* `npm install nomnoml`
* `npm run docs`
Documentation will be generated in `target/docs`. Note that diagram
generation is dependent on having [Cairo](http://cairographics.org/download/)
installed; see
[node-canvas](https://github.com/Automattic/node-canvas#installation)'s
documentation for help with installation.
Documentation will be generated in `target/docs`.
# Glossary

View File

@ -2,6 +2,7 @@ deployment:
production:
branch: master
commands:
- npm install nomnoml
- ./build-docs.sh
- git push git@heroku.com:openmctweb-demo.git $CIRCLE_SHA1:refs/heads/master
openmctweb-staging-un:

View File

@ -7,7 +7,6 @@
"minimist": "^1.1.1"
},
"devDependencies": {
"canvas": "^1.2.7",
"glob": ">= 3.0.0",
"jasmine-core": "^2.3.0",
"jsdoc": "^3.3.2",
@ -24,7 +23,6 @@
"markdown-toc": "^0.11.7",
"marked": "^0.3.5",
"mkdirp": "^0.5.1",
"nomnoml": "^0.0.3",
"requirejs": "^2.1.17",
"split": "^1.0.0"
},