autodoc2_module_summary = False should still print non-summary API
#53
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When `autodoc2_module_summary = False`, each module's page only includes the "Submodules" heading at the top and no other API documentation. I assume this is unintended, and the "summary" being referenced in this config option should only be the tables of each item type at the top of each module. I think this might have been an off-by-one indentation level error? The code to render the non-summary parts was accidentally indented to the level of the summary check `if`. If the existing behavior is the intended behavior of this config option, let me know and maybe we can change this to better document what the behavior should be. I didn't include any tests because I didn't see a pattern for handling combinations of config options, but I did test manually. If you want me to add something that tests this in isolation, let me know. Thanks!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When
autodoc2_module_summary = False, each module's page only includes the "Submodules" heading at the top and no other API documentation. I assume this is unintended, and the "summary" being referenced in this config option should only be the tables of each item type at the top of each module.I think this might have been an off-by-one indentation level error? The code to render the non-summary parts was accidentally indented to the level of the summary check
if.If the existing behavior is the intended behavior of this config option, let me know and maybe we can change this to better document what the behavior should be.
I didn't include any tests because I didn't see a pattern for handling combinations of config options, but I did test manually. If you want me to add something that tests this in isolation, let me know.
Thanks!