Skip to content

Commit

Permalink
docs: fix incorrectly generated api docs
Browse files Browse the repository at this point in the history
Fixes #7287

The `api-samples` was incorrectly included in the generated docs since it
had a `.tsx` file included. Due to the `typedoc.json` exclude rule not
handling the case it was displayed. The `exclude` rule was updated to be
more generic and not publish any documentation for the directories:
- `dev-packages`
- `examples`
- `typings`

Signed-off-by: Vincent Fugnitto <vincent.fugnitto@ericsson.com>
  • Loading branch information
vince-fugnitto committed Mar 6, 2020
1 parent 842e717 commit 4211025
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion configs/typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"external-modulemap": ".*\/packages\/([\\w\\-_]+)\/",
"name": "Theia TypeDoc",
"exclude": [
"**/+(dev-packages|examples|typings)/**/*.ts",
"**/+(dev-packages|examples|typings)/**/*",
"**/*spec.ts"
]
}

0 comments on commit 4211025

Please sign in to comment.