Skip to content
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

Never skip modules and packages #453

Closed
wants to merge 4 commits into from
Closed

Conversation

sachahu1
Copy link

This fixes #448 and #441 which happen because missing option "undoc-members" causes modules and packages not to be documented. This enforces that all modules and all packages will always be documented.

Copy link
Collaborator

@AWhetter AWhetter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please can you add test(s) for this.

autoapi/_objects.py Outdated Show resolved Hide resolved
@sachahu1
Copy link
Author

@AWhetter Added some simple integration tests

@sachahu1 sachahu1 requested a review from AWhetter June 26, 2024 10:19
@sachahu1
Copy link
Author

@AWhetter Are you happy to merge this?

@AWhetter
Copy link
Collaborator

As mentioned here, I think that the current behaviour is correct. What I failed to do was introduce this change in a major version.
If there's a need to be able to configure the rendering of undocumented members separately from the rendering of undocumented modules then we could consider adding an undoc-modules option to autoapi_options. But the list of options is already quite long so I'd want to see multiple users asking for it, to justify the extra complexity. We'd also need to introduce this change in a major version.
Thank you for going above and beyond to bring this issue to my attention.

@AWhetter AWhetter closed this Jul 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants