summaryrefslogtreecommitdiffstats
path: root/docs/reference.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference.rst')
-rw-r--r--docs/reference.rst54
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/reference.rst b/docs/reference.rst
new file mode 100644
index 0000000..fa0ef3c
--- /dev/null
+++ b/docs/reference.rst
@@ -0,0 +1,54 @@
+Package Contents
+================
+
+.. automodule:: polymatrix
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+PolyMatrix Module
+=================
+
+.. automodule:: polymatrix.polymatrix
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Abstract Base Classes
+---------------------
+
+.. automodule:: polymatrix.polymatrix.abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Mixins
+------
+
+.. automodule:: polymatrix.polymatrix.mixins
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Index Types
+-----------
+
+.. automodule:: polymatrix.polymatrix.typing
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+..
+ Mixin implementations
+ ---------------------
+
+ .. automodule:: polymatrix.polymatrix.impl
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+ .. automodule:: polymatrix.polymatrix.init
+ :members:
+ :undoc-members:
+ :show-inheritance: