Skip to content

Commit

Permalink
Added esdoc support
Browse files Browse the repository at this point in the history
  • Loading branch information
Manjiri Tapaswi committed Oct 27, 2017
1 parent 8b46cb7 commit 35c414b
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .esdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"source": "./lib",
"destination": "./docs",
"plugins": [
{
"name": "esdoc-coverage-plugin",
"option": {
"enable": true,
"kind": ["class", "method", "member", "get", "set", "constructor", "function", "variable"]
}
}
]
}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules/
.DS_Store
npm-debug.log
docs
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ Generally, we follow the style guidelines as suggested by the official language.
Please run your code through:

- [ESLint](http://eslint.org/) with the standard style guide.
- [esdoc](https://github.com/sendgrid/smtpapi-nodejs/blob/master/.github/USAGE.md) to check the documentation coverage of your added code.

## Creating a Pull Request<a name="creating_a_pull_request"></a>

Expand Down
11 changes: 11 additions & 0 deletions USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Documentation

If you would like to auto-generate documentation of the packages, you can do so locally by running:
```
./node_modules/.bin/esdoc
```
Using the .esdoc.json file, esdoc will create documentation in the docs directory.

## Checking docs coverage

You will find a coverage.json file in the docs directory. This will contain information about the documentation coverage for each of the different files in this repo.
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
"author": "scottmotte",
"license": "BSD",
"dependencies": {
"chai": "^2.3.0",
"esdoc": "^1.0.3",
"esdoc-coverage-plugin": "^1.1.0",
"esdoc-type-inference-plugin": "^1.0.1"
},
"devDependencies": {
"mocha": "",
Expand Down

0 comments on commit 35c414b

Please sign in to comment.