diff options
| author | Nao Pross <np@0hm.ch> | 2024-04-29 14:12:22 +0200 |
|---|---|---|
| committer | Nao Pross <np@0hm.ch> | 2024-04-29 14:12:22 +0200 |
| commit | 6b16f20e5c965406b841790ca0d7ae56925860ac (patch) | |
| tree | 01bed1c72b1fcaa9fd0a65f36a233de6febbcdf7 /docs/reference.rst | |
| parent | Add total order to MonomialIndex (diff) | |
| download | polymatrix-6b16f20e5c965406b841790ca0d7ae56925860ac.tar.gz polymatrix-6b16f20e5c965406b841790ca0d7ae56925860ac.zip | |
Add sphinx documentation generator
To generate the documentation run
$ make -C docs html
Diffstat (limited to 'docs/reference.rst')
| -rw-r--r-- | docs/reference.rst | 54 |
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: |