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

Prevent typedoc from detecting every index file as a module #17

Merged
merged 1 commit into from
Mar 7, 2023

Conversation

timothymcmackin
Copy link
Contributor

The typedoc.json file has this line:

  "entryPoints": ["./packages/**"],

This make typedoc see every index file in packages/ as a package, at every level.

As a result, the output shows several incorrect packages:
image

This PR changes it so only folders at the base level of packages/ become packages in the output:
image

To test:

  1. Load this PR
  2. Run yarn install && yarn build && yarn doc
  3. Look at the file doc/index.html and verify that it shows only the provider and NFT checkout packages.

@timothymcmackin timothymcmackin self-assigned this Mar 7, 2023
@timothymcmackin timothymcmackin marked this pull request as ready for review March 7, 2023 15:36
@napalmpapalam napalmpapalam merged commit 5670906 into rarimo:main Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants