Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 87 lines (71 sloc) 2.701 kb
d86f1809 »
2008-07-26 Cataloging for repoze.
1 # Makefile for Sphinx documentation
2 #
3
4 # You can set these variables from the command line.
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
5 SPHINXOPTS = -W
d86f1809 »
2008-07-26 Cataloging for repoze.
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
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
12 ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
d86f1809 »
2008-07-26 Cataloging for repoze.
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:
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
26 -rm -rf _build/*
d86f1809 »
2008-07-26 Cataloging for repoze.
27
28 html:
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
29 mkdir -p _build/html _build/doctrees
30 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
d86f1809 »
2008-07-26 Cataloging for repoze.
31 @echo
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
32 @echo "Build finished. The HTML pages are in _build/html."
33
34 text:
35 mkdir -p _build/text _build/doctrees
36 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) _build/text
37 @echo
38 @echo "Build finished. The HTML pages are in _build/text."
d86f1809 »
2008-07-26 Cataloging for repoze.
39
40 pickle:
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
41 mkdir -p _build/pickle _build/doctrees
42 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
d86f1809 »
2008-07-26 Cataloging for repoze.
43 @echo
44 @echo "Build finished; now you can process the pickle files or run"
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
45 @echo " sphinx-web _build/pickle"
d86f1809 »
2008-07-26 Cataloging for repoze.
46 @echo "to start the sphinx-web server."
47
48 web: pickle
49
50 htmlhelp:
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
51 mkdir -p _build/htmlhelp _build/doctrees
52 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
d86f1809 »
2008-07-26 Cataloging for repoze.
53 @echo
54 @echo "Build finished; now you can run HTML Help Workshop with the" \
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
55 ".hhp project file in _build/htmlhelp."
d86f1809 »
2008-07-26 Cataloging for repoze.
56
57 latex:
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
58 mkdir -p _build/latex _build/doctrees
59 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
60 cp _static/*.png _build/latex
61 ./convert_images.sh
62 cp _static/latex-warning.png _build/latex
63 cp _static/latex-note.png _build/latex
d86f1809 »
2008-07-26 Cataloging for repoze.
64 @echo
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
65 @echo "Build finished; the LaTeX files are in _build/latex."
d86f1809 »
2008-07-26 Cataloging for repoze.
66 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
67 "run these through (pdf)latex."
68
69 changes:
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
70 mkdir -p _build/changes _build/doctrees
71 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
d86f1809 »
2008-07-26 Cataloging for repoze.
72 @echo
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
73 @echo "The overview file is in _build/changes."
d86f1809 »
2008-07-26 Cataloging for repoze.
74
75 linkcheck:
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
76 mkdir -p _build/linkcheck _build/doctrees
77 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
d86f1809 »
2008-07-26 Cataloging for repoze.
78 @echo
79 @echo "Link check complete; look for any errors in the above output " \
6d2acbe1 »
2012-04-15 fix docs rendering, add docs alias to setup.cfg, move README.txt to R…
80 "or in _build/linkcheck/output.txt."
81
82 epub:
83 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) _build/epub
84 @echo
85 @echo "Build finished. The epub file is in _build/epub."
86
Something went wrong with that request. Please try again.