Improve docstrings for Sphinx documentation

This commit is contained in:
Jonathan Harker 2024-10-02 13:51:52 +13:00
parent 42d4cfb427
commit 64dd35e1f8
4 changed files with 238 additions and 82 deletions

View file

@ -28,6 +28,7 @@ release = '0.1'
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx.ext.napoleon',
'sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.viewcode',

View file

@ -6,6 +6,8 @@ setclass module
.. automodule:: setclass.setclass
:members:
:special-members: __init__
:member-order: bysource
:undoc-members:
:show-inheritance: