Make Read the Docs include autodoc documentation for special-members? Make Read the Docs include autodoc documentation for special-members? python python

Make Read the Docs include autodoc documentation for special-members?


In case you are using Napoleon extension to handle NumPy or Google style docstrings, you can set a configuration flag for this in your conf.py

http://sphinx-doc.org/ext/napoleon.html?highlight=special#confval-napoleon_include_special_with_doc

If I remember correctly there is also a directive for autodoc:

http://sphinx-doc.org/ext/autodoc.html?highlight=member#event-autodoc-skip-member

By implementing this method you have a fine grained choice of which member is going to be included in the docs and which is not.