From 584c527bfb647ec16609bf79864292399cef54e3 Mon Sep 17 00:00:00 2001 From: Nao Pross Date: Sun, 3 Mar 2024 03:15:40 +0100 Subject: Setup Sphinx documentation generator --- docs/reference.rst | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 docs/reference.rst (limited to 'docs/reference.rst') 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: -- cgit v1.2.1