readthedocs
A user tool to debug visibility of objects
It seems users can get quite disoriented when switching off "undoc-members" - whole modules will stop rendering even though there may be documented objects within.
This PR adds a config that helps users to debug why items may not be rendering, and also adds an info log for the common case of the module itself missing top level documentation in init.py
Interested in your thoughts!
This is a great idea! Thanks for making the change. I've left some comments for improvements.
Thank you, glad this is appreciated!
One question I have - with the 'hide reason' enum idea, we could use this in autoapi-skip-member interface. Do you think it would make sense to add this to that api?
I'm having some odd issues running the tests in tox - they're working when i run manually for 3.9 and 3.13, but failing under the tox runs. Any guidance appreciated!
One question I have - with the 'hide reason' enum idea, we could use this in autoapi-skip-member interface. Do you think it would make sense to add this to that api?
Good point. If we use an enum then someone can't extend that enum easily to add their own reasons for something being skipped. Perhaps letting autoapi-skip-member return a string (with the return type bool | str | None) would be best. What do you think?
Yep, the enum is a string enum already , so exposing as a string makes most sense.
On Thu, 5 Jun 2025 at 16:10, Ashley Whetter @.***> wrote:
AWhetter left a comment (readthedocs/sphinx-autoapi#522) https://github.com/readthedocs/sphinx-autoapi/pull/522#issuecomment-2944932803
One question I have - with the 'hide reason' enum idea, we could use this in autoapi-skip-member interface. Do you think it would make sense to add this to that api?
Good point. If we use an enum then someone can't extend that enum easily to add their own reasons for something being skipped. Perhaps letting autoapi-skip-member return a string (with the return type bool | str | None) would be best. What do you think?
— Reply to this email directly, view it on GitHub https://github.com/readthedocs/sphinx-autoapi/pull/522#issuecomment-2944932803, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAB4O4FCPF2K7COGG2EGVBT3CBMVVAVCNFSM6AAAAAB4SOQBBGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSNBUHEZTEOBQGM . You are receiving this because you authored the thread.Message ID: @.***>