-
Notifications
You must be signed in to change notification settings - Fork 712
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
Only generate legend for items that are displayed on the page #1136
Only generate legend for items that are displayed on the page #1136
Comments
For TypeStrong#1136 Will require another change to typedoc-default-themes
For TypeStrong#1136 Will require another change to typedoc-default-themes
For TypeStrong#1136 Will require another change to typedoc-default-themes
That definitely looks like a bug, looks like we are missing There was a bug in a previous version caused by the rename from "External Modules" to "Modules", are you on the latest version? |
I'm using 0.17.4 |
Could you open a new issue with a reproduction? Seems to be working correctly based on a quick test with the symbols I noted are missing that I just did. |
I have the same problem. Enum and other types are missing. I am using mode "file". |
I am having the same issue with the enums. Interestingly the "Enumeration" shows up in my real project and the "Enumeration member" is missing, but in my reproducer both of them are missing. |
Problem
Currently, the legend at the bottom is cluttered with ALL possible types of exports including some particularly rare ones. This can often lead to a feeling of being lost in some readers, when first looking at the bottom of the page.
For example, if viewing a class that only contains some methods and properties, it's pretty useless for the reader to be reminded about icons for enums, enumeration members or variables...
Suggested Solution
It should be possible to only render legend for the items that are currently present on the page.
This would greatly benefit documentation simplicity of the small packages with short API-s.
The text was updated successfully, but these errors were encountered: