diff options
| author | Nao Pross <np@0hm.ch> | 2024-03-03 03:15:40 +0100 |
|---|---|---|
| committer | Nao Pross <np@0hm.ch> | 2024-03-03 03:15:40 +0100 |
| commit | 584c527bfb647ec16609bf79864292399cef54e3 (patch) | |
| tree | e399a86812445dd115bc7e25d8f6330636c9f48a /docs/reference.rst | |
| parent | Improve docstrings (diff) | |
| download | mdpoly-584c527bfb647ec16609bf79864292399cef54e3.tar.gz mdpoly-584c527bfb647ec16609bf79864292399cef54e3.zip | |
Setup Sphinx documentation generator
Diffstat (limited to '')
| -rw-r--r-- | docs/reference.rst | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/docs/reference.rst b/docs/reference.rst new file mode 100644 index 0000000..89f5bfb --- /dev/null +++ b/docs/reference.rst @@ -0,0 +1,83 @@ +Package Reference +================= + +Module contents +--------------- + +.. automodule:: mdpoly + :members: + :undoc-members: + :show-inheritance: + + +mdpoly.abc +---------- + +.. automodule:: mdpoly.abc + :members: + :undoc-members: + :show-inheritance: + +mdpoly.algebra +-------------- + +.. automodule:: mdpoly.algebra + :members: + :undoc-members: + :show-inheritance: + +mdpoly.constants +---------------- + +.. automodule:: mdpoly.constants + :members: + :undoc-members: + :show-inheritance: + +mdpoly.errors +------------- + +.. automodule:: mdpoly.errors + :members: + :undoc-members: + :show-inheritance: + +mdpoly.leaves +------------- + +.. automodule:: mdpoly.leaves + :members: + :undoc-members: + :show-inheritance: + +mdpoly.representations +---------------------- + +.. automodule:: mdpoly.representations + :members: + :undoc-members: + :show-inheritance: + +mdpoly.state +------------ + +.. automodule:: mdpoly.state + :members: + :undoc-members: + :show-inheritance: + +mdpoly.types +------------ + +.. automodule:: mdpoly.types + :members: + :undoc-members: + :show-inheritance: + +mdpoly.util +----------- + +.. automodule:: mdpoly.util + :members: + :undoc-members: + :show-inheritance: |