feat: use typedoc to generate a json file documentation dump of all components #1887
Conversation
googlebot
added
the
cla: yes
|
|
||
| ## Example Usage | ||
|
|
||
| ### Hiding methods in a class |
There was a problem hiding this comment.
Rather than hiding the methods with @hidden, I'd rather just ignore them when we're processing the json for the docs site. The vast majority of methods and properties won't be public, so using @hidden would add a lot of noise to the source.
| ## Generating docs for one component | ||
|
|
||
| ``` | ||
| npm run docs ./src/lib/button |
There was a problem hiding this comment.
We should make a gulp task for this.
| @@ -0,0 +1,21 @@ | |||
| { | |||
| "mode": "modules", | |||
| "out": "./docs/autogen", | |||
There was a problem hiding this comment.
do you have a preference name for the json file? I call it output.json though api.json might be more fitting.
| "excludeExternals": "true", | ||
| "includeDeclarations": "true", | ||
| "target": "ES6", | ||
| "exclude": "**/+(index.ts|*.spec.ts|*.scss|*.html)", |
There was a problem hiding this comment.
We don't necessarily want to exclude index.ts because we do define some constructs there.
(though maybe we shouldn't)
| "out": "./docs/autogen", | ||
| "json": "./docs/autogen/output.json", | ||
| "theme": "default", | ||
| "ignoreCompilerErrors": "true", |
There was a problem hiding this comment.
I'll remove it, it was useful for testing individual components which didn't have typings in the same folder (src/lib/button). However, if I run npm run docs ./src/lib no errors will be produced since the tsconfig and typings files are found. We should still be able to specify that flag on an individual basis --ignoreCompilerErrors.
|
LGTM |
jelbourn
added
pr: lgtm
action: merge
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
@jelbourn
I've modifiedbutton.tsas an example on how to hide underscored methods and to hide its constructor.