# Minimal makefile for Sphinx documentation # # You can set these variables from the command line, and also # from the environment for the first two. ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source SPHINXOPTS = SPHINXBUILD = sphinx-build SOURCEDIR = source BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) @echo " spelling to check for typos in documentation" .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) spelling: $(SPHINXBUILD) -b spelling -W $(SOURCEDIR) $(BUILDDIR)/spelling @echo @echo "Check finished. Wrong words can be found in " \ "build/spelling/output.txt."