-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Manjiri Tapaswi
committed
Oct 27, 2017
1 parent
8b46cb7
commit 35c414b
Showing
5 changed files
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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"] | ||
} | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
node_modules/ | ||
.DS_Store | ||
npm-debug.log | ||
docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters