2012-12-13 15:43:05 +01:00
|
|
|
# Makefile for Sphinx documentation
|
2015-07-20 07:18:47 +02:00
|
|
|
SPHINXOPTS =
|
|
|
|
SPHINXBUILD = sphinx-build
|
|
|
|
PAPER =
|
|
|
|
BUILDDIR = _build
|
2012-12-13 15:43:05 +01:00
|
|
|
|
|
|
|
# Internal variables
|
|
|
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
|
|
PAPEROPT_letter = -D latex_paper_size=letter
|
2014-10-25 19:31:23 +02:00
|
|
|
ALLSPHINXOPTS = -T -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
2012-12-13 15:43:05 +01:00
|
|
|
|
2012-12-14 14:03:59 +01:00
|
|
|
GH_PAGES_SOURCES = source Makefile
|
|
|
|
GH_SOURCE_BRANCH = develop
|
2012-12-13 15:43:05 +01:00
|
|
|
|
2014-10-12 17:37:58 +02:00
|
|
|
.PHONY: html clean html latexpdf
|
|
|
|
|
|
|
|
help:
|
|
|
|
@echo "Please use \`make <target>' where <target> is one of"
|
|
|
|
@echo " html to make standalone HTML files"
|
|
|
|
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
2012-12-13 15:43:05 +01:00
|
|
|
|
|
|
|
clean:
|
|
|
|
-rm -rf $(BUILDDIR)/*
|
|
|
|
|
2014-10-12 17:37:58 +02:00
|
|
|
latexpdf:
|
|
|
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
|
|
@echo "Running LaTeX files through pdflatex..."
|
|
|
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
|
|
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
|
|
|
2012-12-13 15:43:05 +01:00
|
|
|
html:
|
|
|
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
|
|
|
@echo
|
|
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
2014-10-25 19:31:23 +02:00
|
|
|
|
|
|
|
man:
|
|
|
|
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
|
|
|
@echo
|
|
|
|
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|