provide option to include private and special members
it's pretty standard practice in API documentation to include special methods such as:
__add__, __mul__, __div__
because they are essential to conveying the purpose and usage of the class. additional options should be added along the lines of "undoc-members", for including special methods:
and private methods:
_foo, __foo, _foo_
it's important to have individual control over these since it is often the case that private members should be skipped while special members should be documented.
.. autoclass:: Foo :members: :private-members: :special-members:
NOTE: i am aware that "autodoc-skip-member" event can be used for this purpose, but 99% of us are not willing to write custom modules and callbacks to accomplish something as simple and essential as including private members -- it should just work. to my knowledge, the sphinx docs do not even provide examples of how one would go about hooking up an event callback. it is unrealistic to expect the average user to delve into this magic to accomplish something so fundamental.