2022-10-20 16:51:32 +00:00
|
|
|
# Makefile for Sphinx documentation generated by sphinx-quickstart
|
|
|
|
|
# ----------------------------------------------------------------------------
|
2017-06-02 20:13:31 +00:00
|
|
|
|
2022-10-20 16:51:32 +00:00
|
|
|
# You can set these variables from the command line, and also
|
|
|
|
|
# from the environment for the first two.
|
|
|
|
|
SPHINXOPTS ?=
|
|
|
|
|
SPHINXBUILD ?= sphinx-build
|
2017-06-02 20:13:31 +00:00
|
|
|
SOURCEDIR = source
|
2022-10-20 16:51:32 +00:00
|
|
|
BUILDDIR = _build
|
2017-06-02 20:13:31 +00:00
|
|
|
|
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
|
|
|
help:
|
2022-10-20 16:51:32 +00:00
|
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
|
2017-06-02 20:13:31 +00:00
|
|
|
|
|
|
|
|
.PHONY: help Makefile
|
|
|
|
|
|
|
|
|
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
2022-10-20 16:51:32 +00:00
|
|
|
# "make mode" option.
|
2017-06-02 20:13:31 +00:00
|
|
|
%: Makefile
|
2022-10-20 16:51:32 +00:00
|
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Manually added commands
|
|
|
|
|
# ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
# For local development:
|
|
|
|
|
# - builds and rebuilds html on changes to source
|
|
|
|
|
# - starts a livereload enabled webserver and opens up a browser
|
|
|
|
|
devenv:
|
|
|
|
|
sphinx-autobuild -b html --open-browser "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS)
|
|
|
|
|
|
|
|
|
|
# For local development and CI:
|
|
|
|
|
# - verifies that links are valid
|
|
|
|
|
linkcheck:
|
|
|
|
|
$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)/linkcheck" $(SPHINXOPTS)
|
|
|
|
|
@echo
|
|
|
|
|
@echo "Link check complete; look for any errors in the above output " \
|
|
|
|
|
"or in $(BUILDDIR)/linkcheck/output.txt."
|
