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

Individual --exclude patterns per entryPoint possible? #2208

Closed
opt12 opened this issue Mar 22, 2023 · 2 comments
Closed

Individual --exclude patterns per entryPoint possible? #2208

opt12 opened this issue Mar 22, 2023 · 2 comments
Labels
question Question about functionality

Comments

@opt12
Copy link

opt12 commented Mar 22, 2023

Search terms

exclude, entryPoint, expand

Question

Is it somehow possible to have an individual exclude pattern for each entry point specified in conjunction with the entryPointStrategy "expand"?

In our use case, we want to have a unified documentation for a bunch of different apps and libraries in a monorepo.
We achieve this by using the "typedoc-plugin-merge-modules" and the "typedoc-plugin-resolve-crossmodule-references".

All in all this works out quite well.

Unfortunately, the usage of file-types differs from portion to portion in our code. So it would be helpful to have an individual exclude list per each specified entryPoint.

  • Is this somehow achievable?

  • Is it achievable to have different typedoc settings in different areas of the monorepo's sources? E. g. by placing different typedoc.json files in the root of each entry-point?

Thanks a lot!
Felix

@opt12 opt12 added the question Question about functionality label Mar 22, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 24, 2023

Nope, that's not possible for expand, implementing that would be a complete rework of how that entry point strategy is handled.

TypeDoc 0.24's packages mode (see #2197) provides the ability to have different configuration in each module, and should be a much better configuration setting for monorepos.

@opt12
Copy link
Author

opt12 commented Mar 25, 2023

Ok, I'll give the 0.24 a try and see, whether this could serve our needs. Thanks for your incredible work.

@Gerrit0 Gerrit0 closed this as completed Apr 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality
Projects
None yet
Development

No branches or pull requests

2 participants