docs: fix incorrectly generated api docs #7288
Merged
Conversation
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
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>
vince-fugnitto
added
bug
paul-marechal
approved these changes
Mar 9, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it does
Fixes #7287
The
api-sampleswas incorrectly included in the generated docs since it had a.tsxfile included. Due to thetypedoc.jsonexclude rule not handling the case it was displayed. Theexcluderule was updated to be more generic and not publish any documentation for the directories:dev-packagesexamplestypingsHow to test
yarn run docsgh-pages/docs/next/index.htmland verify if the bug has been successfully fixedReview checklist
Reminder for reviewers