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/Makefile | |
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 '')
-rw-r--r-- | docs/Makefile | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |