Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 69 lines (57 sloc) 2.168 kb
a8312bd Initial commit
Gabriel Gellner authored
1 # Makefile for Sphinx documentation
2 #
3
4 # You can set these variables from the command line.
5 SPHINXOPTS =
6 SPHINXBUILD = sphinx-build
7 PAPER =
8
9 # Internal variables.
10 PAPEROPT_a4 = -D latex_paper_size=a4
11 PAPEROPT_letter = -D latex_paper_size=letter
12 ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
13
14 .PHONY: help clean html web htmlhelp latex changes linkcheck
15
16 help:
17 @echo "Please use \`make <target>' where <target> is one of"
18 @echo " html to make standalone HTML files"
19 @echo " web to make files usable by Sphinx.web"
20 @echo " htmlhelp to make HTML files and a HTML help project"
21 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
22 @echo " changes to make an overview over all changed/added/deprecated items"
23 @echo " linkcheck to check all external links for integrity"
24
25 clean:
26 -rm -rf build/*
27
28 html:
29 mkdir -p build/html build/doctrees
30 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
31 @echo
32 @echo "Build finished. The HTML pages are in build/html."
33
34 web:
35 mkdir -p build/web build/doctrees
36 $(SPHINXBUILD) -b web $(ALLSPHINXOPTS) build/web
37 @echo
38 @echo "Build finished; now you can run"
39 @echo " python -m sphinx.web build/web"
40 @echo "to start the server."
41
42 htmlhelp:
43 mkdir -p build/htmlhelp build/doctrees
44 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
45 @echo
46 @echo "Build finished; now you can run HTML Help Workshop with the" \
47 ".hhp project file in build/htmlhelp."
48
49 latex:
50 mkdir -p build/latex build/doctrees
51 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
52 @echo
53 @echo "Build finished; the LaTeX files are in build/latex."
54 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
55 "run these through (pdf)latex."
56
57 changes:
58 mkdir -p build/changes build/doctrees
59 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
60 @echo
61 @echo "The overview file is in build/changes."
62
63 linkcheck:
64 mkdir -p build/linkcheck build/doctrees
65 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
66 @echo
67 @echo "Link check complete; look for any errors in the above output " \
68 "or in build/linkcheck/output.txt."
Something went wrong with that request. Please try again.