diff options
| author | reivilibre <oliverw@matrix.org> | 2023-03-24 16:41:10 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-24 16:41:10 +0000 |
| commit | d5324ee111ea56fa466eab7e3974dc4894a64d46 (patch) | |
| tree | ff7b2523083d585eea3e8f4548c96634f4fb0192 /dev-docs/Makefile | |
| parent | As an optimisation, use `TRUNCATE` on Postgres when clearing the user directo... (diff) | |
| download | synapse-d5324ee111ea56fa466eab7e3974dc4894a64d46.tar.xz | |
Add developer documentation for the Federation Sender and add a documentation mechanism using Sphinx. (#15265)
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Diffstat (limited to 'dev-docs/Makefile')
| -rw-r--r-- | dev-docs/Makefile | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/dev-docs/Makefile b/dev-docs/Makefile new file mode 100644 index 0000000000..d4bb2cbb9e --- /dev/null +++ b/dev-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) |