From 6b16f20e5c965406b841790ca0d7ae56925860ac Mon Sep 17 00:00:00 2001
From: Nao Pross <np@0hm.ch>
Date: Mon, 29 Apr 2024 14:12:22 +0200
Subject: Add sphinx documentation generator

To generate the documentation run

  $ make -C docs html
---
 docs/reference.rst | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 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..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:
-- 
cgit v1.2.1