Ashley Whetter
Ashley Whetter
I'm going to close this now that we have `native_enum` :tada:
For (1), this page outlines how you can customise what gets documented: https://sphinx-autoapi.readthedocs.io/en/latest/how_to.html#how-to-customise-what-gets-documented So you could either set an `__all__` or filter out `__version__` using a function connected to the...
It should be possible to change AutoAPI to inspect the class docstring and omit the separate documenting of attributes if they're already covered in the class docstring.
AutoAPI used to ignore instance attributes that didn't have a docstring. That was counter to how every other member worked so it was changed in v3.2 such that instance attributes...
@jloehel I've added an example to my comment above (https://github.com/readthedocs/sphinx-autoapi/issues/476#issuecomment-2316718949).
I can't reproduce this behaviour. `__all__` will only be documented if `special-members` is turned on, which it is by default, and as was the case in the zarr code base...
Closing due to lack of feedback. So I'll assume this got resolved. Please let me know if this is still an issue. It would also be useful if you could...
A similar request was made in #401. It seems like a plugin interface would be useful for users in more than that one case. Hopefully we'll get this for free...
Thanks for making this change. Why is this needed?
Thanks for fixing this yourself and keep the pull request up to date. I've merged this as 0d5f21b8650d6202208f0cf00f498a16a1e32379