Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: incorrect generated doc for 'sample-uncloseable-view' #7287

Closed
vince-fugnitto opened this issue Mar 6, 2020 · 0 comments · Fixed by #7288
Closed

docs: incorrect generated doc for 'sample-uncloseable-view' #7287

vince-fugnitto opened this issue Mar 6, 2020 · 0 comments · Fixed by #7288
Labels
bug bugs found in the application documentation issues related to documentation

Comments

@vince-fugnitto
Copy link
Member

Description

Following the pull-request #7278, the generated API doc now references sample-unclosable-view incorrectly. Upon clicking the link a 404 error is displayed:

image

image

@vince-fugnitto vince-fugnitto added bug bugs found in the application documentation issues related to documentation labels Mar 6, 2020
vince-fugnitto added a commit that referenced this issue Mar 6, 2020
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 a commit that referenced this issue Mar 12, 2020
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug bugs found in the application documentation issues related to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant