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/index.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/index.rst')
| -rw-r--r-- | docs/index.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..8389b3a --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,22 @@ +.. polymatrix documentation master file, created by + sphinx-quickstart on Wed Apr 24 15:20:48 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to polymatrix's documentation! +====================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + reference + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` |