Skip to content

Commit 38b7a4d

Browse files
davidjoyAdam Butterworth
authored andcommitted
Generating API Documentation (#34)
* docs: attempt at generated docs ./node_modules/.bin/documentation build src/index.js --config documentation.yml -f html -o documentation * docs: documentationjs works and generates API.md * docs: decorating all public members with jsdoc comments Doing this gets them included in the generated API.md documentation. Also regenerating the API.md doc.
1 parent ec38306 commit 38b7a4d

40 files changed

+3890
-118
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
coverage
55
dist
66
node_modules
7+
/docs/_API-body.md

Makefile

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# Documentation CLI usage: https://github.com/documentationjs/documentation/blob/master/docs/USAGE.md
2+
3+
doc_command = ./node_modules/.bin/documentation build src -g -c ./docs/documentation.config.yml -f md -o ./docs/_API-body.md --sort-order alpha
4+
cat_docs_command = cat ./docs/_API-header.md ./docs/_API-body.md > ./docs/API.md
5+
16
build:
27
rm -rf ./dist
38
./node_modules/.bin/fedx-scripts babel src --out-dir dist --source-maps --ignore **/*.test.jsx,**/*.test.js,**/setupTest.js --copy-files
@@ -7,3 +12,15 @@ build:
712
cp ./package.json ./dist/package.json
813
cp ./LICENSE ./dist/LICENSE
914
cp ./README.md ./dist/README.md
15+
16+
docs-build:
17+
${doc_command}
18+
${cat_docs_command}
19+
rm ./docs/_API-body.md
20+
21+
docs-watch:
22+
@echo "NOTE: Please load _API-body.md to see watch results."
23+
${doc_command} -w
24+
25+
docs-lint:
26+
./node_modules/.bin/documentation lint src

0 commit comments

Comments
 (0)