72 lines
2.6 KiB
Makefile
72 lines
2.6 KiB
Makefile
|
# Makefile for Sphinx documentation
|
||
|
|
#
|
||
|
|
|
||
|
|
# You can set these variables from the command line.
|
||
|
|
SPHINXOPTS =
|
||
|
|
SPHINXBUILD = sphinx-build
|
||
|
|
PAPER =
|
||
|
|
BUILDDIR = _build
|
||
|
|
|
||
|
|
# User-friendly check for sphinx-build
|
||
|
|
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
||
|
|
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
||
|
|
endif
|
||
|
|
|
||
|
|
# Internal variables.
|
||
|
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
||
|
|
PAPEROPT_letter = -D latex_paper_size=letter
|
||
|
|
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||
|
|
# the i18n builder cannot share the environment and doctrees with the others
|
||
|
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||
|
|
|
||
|
|
.PHONY: help
|
||
|
|
help:
|
||
|
|
@echo "Please use \`make <target>' where <target> is one of"
|
||
|
|
@echo " html to make standalone HTML files"
|
||
|
|
@echo " dirhtml to make HTML files named index.html in directories"
|
||
|
|
@echo " changes to make an overview of all changed/added/deprecated items"
|
||
|
|
@echo " linkcheck to check all external links for integrity"
|
||
|
|
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||
|
|
@echo " coverage to run coverage check of the documentation (if enabled)"
|
||
|
|
|
||
|
|
.PHONY: clean
|
||
|
|
clean:
|
||
|
|
rm -rf $(BUILDDIR)/*
|
||
|
|
|
||
|
|
.PHONY: html
|
||
|
|
html:
|
||
|
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||
|
|
@echo
|
||
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||
|
|
|
||
|
|
.PHONY: dirhtml
|
||
|
|
dirhtml:
|
||
|
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||
|
|
@echo
|
||
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||
|
|
|
||
|
|
.PHONY: changes
|
||
|
|
changes:
|
||
|
|
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||
|
|
@echo
|
||
|
|
@echo "The overview file is in $(BUILDDIR)/changes."
|
||
|
|
|
||
|
|
.PHONY: linkcheck
|
||
|
|
linkcheck:
|
||
|
|
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||
|
|
@echo
|
||
|
|
@echo "Link check complete; look for any errors in the above output " \
|
||
|
|
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||
|
|
|
||
|
|
.PHONY: doctest
|
||
|
|
doctest:
|
||
|
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||
|
|
@echo "Testing of doctests in the sources finished, look at the " \
|
||
|
|
"results in $(BUILDDIR)/doctest/output.txt."
|
||
|
|
|
||
|
|
.PHONY: coverage
|
||
|
|
coverage:
|
||
|
|
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
|
||
|
|
@echo "Testing of coverage in the sources finished, look at the " \
|
||
|
|
"results in $(BUILDDIR)/coverage/python.txt."
|