add compodoc documentation generator #1327
Conversation
There was a problem hiding this comment.
Hey @hatemhosny, great, thank you! Please checkout the comment.
package.json
Outdated
| @@ -19,6 +19,8 @@ | |||
| "lint:ci": "npm run lint && npm run lint:styles", | |||
| "pree2e": "webdriver-manager update --standalone false --gecko false", | |||
| "e2e": "ng e2e", | |||
| "docs": "./node_modules/.bin/compodoc -p src/tsconfig.app.json -d docs", | |||
There was a problem hiding this comment.
Do we really need to specify the relative path to the .bin folder? I believe it could be done in a similar to other commands manner when an executable is resolved by npm (https://github.com/akveo/ngx-admin/pull/1327/files#diff-b9cfc7f2cdf78a7f4b91a753d10865a2R6).
There was a problem hiding this comment.
Hi @nnixaa ,
This is how they use it as stated in the documentation
https://compodoc.github.io/website/guides/installation.html
There was a problem hiding this comment.
Yeah I see, but this doesn't seem to be right, as we hardcode path to .bin folder. Could you try changing it to:
"compodoc": "compodoc",
"docs": "compodoc -p src/tsconfig.app.json -d docs",
"docs:serve": "compodoc -p src/tsconfig.app.json -d docs -s",
|
updated... It does work fine. |
|
Awesome, merged. |
What kind of change does this PR introduce?
Feature
What is the new behavior (if this is a feature change)?
this PR adds support for compodoc angular documentation generator (as discussed in #1326)
Other information:
npm run docsbuilds the documentations indocsfolder.npm run docs:servebuilds the documentations and serves it on http://localhost:8080/More information:
https://compodoc.github.io/website/guides/getting-started.html
https://github.com/compodoc/compodoc