diff options
| author |  Johannes Christ <[email protected]> | 2024-07-24 20:09:42 +0200 |
|---|---|---|
| committer | Johannes Christ <[email protected]> | 2024-07-25 20:06:54 +0200 |
| commit | a4d7e92d544aeb43dbe1fcd8648d97e0dbf7b9d3 (patch) | |
| tree | 183318852234388654c99514e45f095af8c21676 /docs/Makefile | |
| parent | Add link to DevOps Kanban board in meeting template (#420) (diff) | |
Improve documentation
This commit ports our documentation to Sphinx.
The reason for this is straightforward. We need to improve both the
quality and the accessibility of our documentation. Hugo is not capable
of doing this, as its primary output format is HTML. Sphinx builds
plenty of high-quality output formats out of the box, and incentivizes
writing good documentation.
Diffstat (limited to 'docs/Makefile')
| -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) |