Add ESDoc documentation generator
This commit is contained in:
parent
cd0d0c316a
commit
fb4e0b1fca
3 changed files with 42 additions and 22 deletions
16
.travis.yml
16
.travis.yml
|
@ -5,12 +5,13 @@ env:
|
|||
node_js:
|
||||
- "7"
|
||||
addons:
|
||||
firefox: latest
|
||||
- firefox: latest
|
||||
before_script:
|
||||
- sh -e /etc/init.d/xvfb start
|
||||
before_deploy:
|
||||
- mkdir -p deploy
|
||||
- ./build.py -l lib -d deploy
|
||||
script:
|
||||
- yarn run build
|
||||
after_success:
|
||||
- yarn run docs
|
||||
notifications:
|
||||
slack:
|
||||
secure: Kwe1KBh4SMzgXaj6GQg3ZmopRYcDR3Vnd4C/gyiEOJsXzKRlU5dA7WwM/mbyOe9+ZvWDyp+g2CoQYYyvLR0SHEy1m0gn6M8fBzgSZQlWxOxAJxkwVsyxUNwAy2FylMpS+ugpw/fBMSbnSFqfZSa/tGB3KhBc0yA7V9wVS0hnwBfICqKKlFdLPcp+Us4zpXRUmcL1e0BVwm2klJi0CoKlOmTa4lI3tUa/YiuuMpgk89/PioMEr6/PP+5OfWV624djw2gznoualvcwdfZniC/oxkdTUbcu4nbTf+bFk5uwwW+XBpUhm9rMUoftngYCrWdtYHS6qenyzmflO5bgCDg5W8onv3qgMcDTEHDjlO8JMoEQLC2o27Hsyukrh2Iu0Hn2k4S10ZIDWLUZXf8ERKdU7v8o5xaiCrP7NO8fJlyGbWwYxwpFi9dpacb8qWuWw53k8+ld9orl2Zu5t1Y1QJCvT0DP0iGYSxbbICfex7im0fgh3A+MHTfhxxiGQtFJRUxqO5wGCIsT4dJJkYwRJ1HoCPyLT1x1WT8iy4lr8ivRhanEwQ5g2OmuRKz522yCrm2DPaRR/LDhqK9xghJqqh4RNx9Be5xNaxSxKs4Hcya4ZXrGaU9tzGTehRkNQksKUHq9PpdY85Mbk84wEq7zKLhtLPTn17DQePFm2DbdX4392o4=
|
||||
|
@ -23,9 +24,10 @@ deploy:
|
|||
on:
|
||||
tags: true
|
||||
- provider: pages
|
||||
github_token:
|
||||
secure: HszUovTqcRxuXTmH3/rStEe1ZeZbrZweQah8Bq0POs89P3/GjyEat11WbH9S7tfIT1yVcF736TmsDNRtl34Rmr71P7rczwFlX1yJOIamH4jT9vG8ocpZH4Orc6XA2s7UclD1HwJwStM1k2J4CV34eTTlX36ngjYrp09HertXAQWSK6TZk9RK6ql2HlNzchImz2EY1aQnfqkrFByOtM4o/SJJryJJBJUMD69gWrYu6cv51w/jMEoUtzvV6Nr2o9YOuo97B0scJmbxgfx67FaCQwEOxKtr8xT5nttJ2q6EeaAiErAieG8/o8yRsJRFrHyVm42v9PEfoe8O8Y4g/1VrtbjY3vH8LPpCotMxhshjUCBaLDc8TCC/osik6dxhv/fqjbdPwrGRW2qzsmXIZug7+YCEW+qUFRPwwX+Cr0ENnaPFMSDFxANeLF7KfF7oaVnr8JTlZnu9G+Uliqe6RNCoWfQtpTRM759cDLQp4b5eBQF2G61x2XOdRqcNZepRaRVnsaCo0lNPW9o5HCQnJnMbEB9Gdowt18PwgVucIdIPJeAPodMs40s7sUOP5Xik58b4YBG9lsgLBcfCgTy+n8JPS2LJsclG82pBACtSV+ucc6rVeD+5fbSUxn4ItaK4e0MonCv4Jnp7zGn6hErcpexBmXSdYQSrdsemKDTGHibOF6U=
|
||||
local_dir: deploy
|
||||
keep-history: true
|
||||
skip_cleanup: true
|
||||
github_token:
|
||||
secure: PvCrB9ckDfWedl1rdo/3mUvCy/Vg4ksZR2mj4KT3AdEyukbpMiVVDkocMFohuIq+mnRdeyhpvM2KluLHhQrEhWjvqVobiZ9/c0gWWxZHV8doDdqNUPm693MpGojMOxHT4qRih6x9KyjanmWAwy/Bc972dpD5vtaTx1gKOzRUjUI=
|
||||
on:
|
||||
branch: master
|
||||
local_dir: docs/
|
||||
|
|
14
esdoc.json
Normal file
14
esdoc.json
Normal file
|
@ -0,0 +1,14 @@
|
|||
{
|
||||
"source": "./octo",
|
||||
"destination": "./docs",
|
||||
"plugins": [
|
||||
{
|
||||
"name": "esdoc-standard-plugin",
|
||||
"option": {
|
||||
"lint": { "enable": true },
|
||||
"coverage": { "enable": true }
|
||||
}
|
||||
},
|
||||
{ "name": "esdoc-node" }
|
||||
]
|
||||
}
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@mozillasecurity/octo",
|
||||
"version": "1.0.14",
|
||||
"version": "1.0.15",
|
||||
"description": "",
|
||||
"keywords": [
|
||||
"fuzzing",
|
||||
|
@ -24,6 +24,7 @@
|
|||
"test": "grunt test --verbose",
|
||||
"test:lint": "cross-env NODE_ENV=test standard --verbose",
|
||||
"test:lint:fix": "cross-env NODE_ENV=test standard --fix --verbose",
|
||||
"docs": "esdoc -c esdoc.json",
|
||||
"build": "webpack -p",
|
||||
"watch": "webpack --watch",
|
||||
"precommit": "npm run test:lint",
|
||||
|
@ -43,6 +44,9 @@
|
|||
},
|
||||
"devDependencies": {
|
||||
"cross-env": "^5.1.4",
|
||||
"esdoc": "^1.1.0",
|
||||
"esdoc-node": "^1.0.3",
|
||||
"esdoc-standard-plugin": "^1.0.0",
|
||||
"grunt": "*",
|
||||
"grunt-karma": "*",
|
||||
"grunt-karma-coveralls": "*",
|
||||
|
|
Loading…
Reference in a new issue