Skip to content

feat: Added esdoc support #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 30, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,4 +1,5 @@
node_modules/
.DS_Store
npm-debug.log
docs
.env
2 changes: 0 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ node_js:
- "6"
- "7"
- "8"
- "node"
- "lts/*"
notifications:
hipchat:
rooms:
Expand Down
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": "3.5.3",
Expand Down