Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 74 lines (60 sloc) 2.324 kb
1ad7722 @bbangert Initial commit.
bbangert 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
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
12 ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1ad7722 @bbangert Initial commit.
bbangert authored
13
14 .PHONY: help clean html web pickle 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 " pickle to make pickle files (usable by e.g. 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:
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
26 -rm -rf _build/*
1ad7722 @bbangert Initial commit.
bbangert authored
27
19d1775 @blaflamme added pylons sphinx theme as a git submodule
blaflamme authored
28 html: themes
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
29 mkdir -p _build/html _build/doctrees
30 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
1ad7722 @bbangert Initial commit.
bbangert authored
31 @echo
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
32 @echo "Build finished. The HTML pages are in _build/html."
1ad7722 @bbangert Initial commit.
bbangert authored
33
34 pickle:
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
35 mkdir -p _build/pickle _build/doctrees
36 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
1ad7722 @bbangert Initial commit.
bbangert authored
37 @echo
38 @echo "Build finished; now you can process the pickle files or run"
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
39 @echo " sphinx-web _build/pickle"
1ad7722 @bbangert Initial commit.
bbangert authored
40 @echo "to start the sphinx-web server."
41
42 web: pickle
43
19d1775 @blaflamme added pylons sphinx theme as a git submodule
blaflamme authored
44 htmlhelp: themes
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
45 mkdir -p _build/htmlhelp _build/doctrees
46 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
1ad7722 @bbangert Initial commit.
bbangert authored
47 @echo
48 @echo "Build finished; now you can run HTML Help Workshop with the" \
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
49 ".hhp project file in _build/htmlhelp."
1ad7722 @bbangert Initial commit.
bbangert authored
50
51 latex:
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
52 mkdir -p _build/latex _build/doctrees
53 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
1ad7722 @bbangert Initial commit.
bbangert authored
54 @echo
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
55 @echo "Build finished; the LaTeX files are in _build/latex."
1ad7722 @bbangert Initial commit.
bbangert authored
56 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
57 "run these through (pdf)latex."
58
59 changes:
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
60 mkdir -p _build/changes _build/doctrees
61 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
1ad7722 @bbangert Initial commit.
bbangert authored
62 @echo
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
63 @echo "The overview file is in _build/changes."
1ad7722 @bbangert Initial commit.
bbangert authored
64
65 linkcheck:
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
66 mkdir -p _build/linkcheck _build/doctrees
67 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
1ad7722 @bbangert Initial commit.
bbangert authored
68 @echo
69 @echo "Link check complete; look for any errors in the above output " \
1eba089 @blaflamme Updated docs for new theme
blaflamme authored
70 "or in _build/linkcheck/output.txt."
71
19d1775 @blaflamme added pylons sphinx theme as a git submodule
blaflamme authored
72 themes:
73 git submodule update --init
Something went wrong with that request. Please try again.