You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
So I'd like to organize items by the file they are defined in but my library uses a single index.ts with re-exports for the bundler. If I also use index.ts as the sole entrypoint for TypeDoc, then the module router will group everything into one route as it sees index.ts as the sole module. However if I pass source files as individual entry points to TypeDoc, the docs will include items that are only exported for internal use.
For now I am considering using @category annotations as a workaround with the category router. Another option would be to use individual entry points and annotate items that are exported for internal use with @internal. But I feel it is too easy to forget that annotation which will lead to internal types making it into the public docs.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
So I'd like to organize items by the file they are defined in but my library uses a single
index.tswith re-exports for the bundler. If I also useindex.tsas the sole entrypoint for TypeDoc, then themodulerouter will group everything into one route as it seesindex.tsas the sole module. However if I pass source files as individual entry points to TypeDoc, the docs will include items that are only exported for internal use.For now I am considering using
@categoryannotations as a workaround with thecategoryrouter. Another option would be to use individual entry points and annotate items that are exported for internal use with@internal. But I feel it is too easy to forget that annotation which will lead to internal types making it into the public docs.Is there an intended way to achieve this?
Beta Was this translation helpful? Give feedback.
All reactions