-
Notifications
You must be signed in to change notification settings - Fork 697
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
Re-exports do not work with library mode #1232
Comments
So, there is a problem here, but it isn't exactly what you thought it was. Version 0.17.0 doesn't include library mode - and TypeDoc has a bug so it doesn't tell you that it is ignoring that you told it to use library mode and is using modules mode #1237.
What you are looking for is not to remove the "externals" (bad name, needs fixing, after library mode is done...) from your documentation (after all, that's where The |
Ok, thank you, sorry if I did not notice library mode was still not available I see now a 0.17.1, is it still without lib mode? When library is available, will I be able to have what I need (have the documentation of all things exported or re-exported by the only index.ts file)? Is there any other way to do this with the current version? |
Yes, library mode is supporting precisely that use case. 0.18 (assuming no required breaking changes are needed before library mode is done) will contain library mode. You can install |
Expected Behavior
On the root of this project, I run this command (after having installed typedoc):
npx typedoc --mode library --inputFiles source/lib/index.ts --tsconfig source/tsconfig.json --out docs/documentation
Everything works well. The index.ts exports a function (generate) and re-exports the Options from another file.
I get something like this:
What I want is the same thing, but without the externals, like this:
Hence I run this command:
npx typedoc --inputFiles source/lib/index.ts --excludeExternals --mode library --tsconfig source/tsconfig.json --out docs/documentation
With the --excludeExternals added
Actual Behavior
The problem is that now the re-exported Options is disappeard, and I get this:
Steps to reproduce the bug
To reproduce, clone this project, install typedoc 0.17.0 as dev dependency and run this:
npx typedoc --inputFiles source/lib/index.ts --excludeExternals --mode library --tsconfig source/tsconfig.json --out docs/documentation
to generate the documentation of source/lib/index.tsEnvironment
The text was updated successfully, but these errors were encountered: