You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
I have a Python project for which I've generated docs. It did well. Almost everything was doc'ed. I knew about the default of excluding anything starting with '_' so I created an autodoc-skip-member function that would include those. It works. I see a bunch of private methods and functions included.
But...I have a module, let's call it XYZ that has both private and public functions. Sphinx is only doc'ing the public functions of XYZ, but not its private functions. I have other modules that have private functions, and it's doc'ing those .I added a print() to the autodoc-skip-member function and it doesn't even print out the name of those private functions so it seems it's not even seeing it.
I figured it out. The module had certain identifiers listed in __all__, and was not passing anything else in that module to autodoc-skip-member.
Describe the solution you'd like
Sphinx should pass through all members, not just the ones in __all__. Maybe add something to the options object that is passed to autodoc-skip-members that indicates it would have been excluded by the __all__ designator, or some such.
Describe alternatives you've considered
I simply removed the __all__ from the file.
The text was updated successfully, but these errors were encountered:
…ot in __all__
This allows `autodoc-skip-member` handlers to determine whether a member
not included in `__all__` attribute of the module should be documented or
not.
Per these resources:
* sphinx-doc/sphinx#8119
* sphinx-doc/sphinx#8125
Sphinx 3.4.0 now handles autodoc-skip-member differently, causing us to run
some tests multiple times due to imported code getting tested.
Per these resources:
* sphinx-doc/sphinx#8119
* sphinx-doc/sphinx#8125
Sphinx 3.4.0 now handles autodoc-skip-member differently, causing us to run
some tests multiple times due to imported code getting tested.
Is your feature request related to a problem? Please describe.
I have a Python project for which I've generated docs. It did well. Almost everything was doc'ed. I knew about the default of excluding anything starting with '_' so I created an autodoc-skip-member function that would include those. It works. I see a bunch of private methods and functions included.
But...I have a module, let's call it XYZ that has both private and public functions. Sphinx is only doc'ing the public functions of XYZ, but not its private functions. I have other modules that have private functions, and it's doc'ing those .I added a print() to the autodoc-skip-member function and it doesn't even print out the
name
of those private functions so it seems it's not even seeing it.I figured it out. The module had certain identifiers listed in
__all__
, and was not passing anything else in that module to autodoc-skip-member.Describe the solution you'd like
Sphinx should pass through all members, not just the ones in
__all__
. Maybe add something to theoptions
object that is passed to autodoc-skip-members that indicates it would have been excluded by the__all__
designator, or some such.Describe alternatives you've considered
I simply removed the
__all__
from the file.The text was updated successfully, but these errors were encountered: