Skip to content Skip to sidebar Skip to footer
Showing posts with the label Sphinx Napoleon
How Can I Apply :special-members: To Just One Class Inside An Automodule Directive?

How Can I Apply :special-members: To Just One Class Inside An Automodule Directive?

Post a Comment
I am putting together Sphinx-driven (v1.3.1) documentation for a Python 2.7 project using autodoc a… Read more How Can I Apply :special-members: To Just One Class Inside An Automodule Directive?
Sphinx Autodoc-skip-member Handler: Can't Show __init__() When Using Napoleon

Sphinx Autodoc-skip-member Handler: Can't Show __init__() When Using Napoleon

Post a Comment
I want to include the docstrings for __init__() in my sphinx-generated documentation. I was followi… Read more Sphinx Autodoc-skip-member Handler: Can't Show __init__() When Using Napoleon
Should I Document Parameters For Similar Function Signatures?

Should I Document Parameters For Similar Function Signatures?

Post a Comment
I have some helper functions that, except for the first argument, take the same arguments as the co… Read more Should I Document Parameters For Similar Function Signatures?