Document only a library's exported files from a given starting point

[manrajgrover]

Currently, typedoc exports all internally exported entities which are not part of the exports in the given starting point. I've been trying to find a way to get past that using available options but looks like this feature is not available.

For example, if starting point is src/index.ts, then only exports from this file should be documented and not all entities. Restricting files in config file or marking every internal utility function as @hidden makes things unmaintainable.

If I have missed anything, please let me know.

[manrajgrover]

@aciccarello Any updates on this?

[aciccarello]

@manrajgrover No movement yet. I like the idea though. Currently the "interval" vs "external" concepts are pretty limited and probably need to be thought through. There is a community made plugin to override these via doc tags if you are interested but it may not fit the bill of what you are looking for.

PRs are welcome ❤️

[manrajgrover]

@aciccarello Thanks for the update. I'm pretty new to TypeScript Compiler API and although I tried going through their examples, I found their documentation lacking in this regard. I would appreciate if you could share more information/pointers on the same.

[aciccarello]

@manrajgrover I didn't write TypeDoc so I don't have much experience with the compiler API. I can tell you that TypeDoc uses some internal TypeScript apis that aren't included in the public api.

[aciccarello]

I'm thinking this would be a new mode (maybe named "library"). I not sure how to handle projects with multiple entry points (e.g. rxjs/Observable vs rxjs/Subject). Ideas are welcome.

[FranklinYu]

Should the new "library" mode ignore everything in node_modules?