1 MKHTML=mkdoc |
|
2 MKHTMLOPTS=--doctype article --target html --stylesheet standard |
|
3 SRC=. |
|
4 |
|
5 TXTFILES:= $(wildcard *.txt) |
|
6 TARGET := $(TXTFILES:.txt=.html) |
|
7 |
|
8 # You can set these sphinx variables from the command line. |
|
9 SPHINXOPTS = |
|
10 SPHINXBUILD = sphinx-build |
|
11 PAPER = |
|
12 |
|
13 # Internal variables for sphinx |
|
14 PAPEROPT_a4 = -D latex_paper_size=a4 |
|
15 PAPEROPT_letter = -D latex_paper_size=letter |
|
16 ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
|
17 |
|
18 |
|
19 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck |
|
20 |
|
21 help: |
|
22 @echo "Please use \`make <target>' where <target> is one of" |
|
23 @echo " all to make standalone HTML files, developer manual and API doc" |
|
24 @echo " apidoc to make API doc" |
|
25 @echo " html to make standalone HTML files" |
|
26 @echo "--- " |
|
27 @echo " pickle to make pickle files (usable by e.g. sphinx-web)" |
|
28 @echo " htmlhelp to make HTML files and a HTML help project" |
|
29 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
|
30 @echo " changes to make an overview over all changed/added/deprecated items" |
|
31 @echo " linkcheck to check all external links for integrity" |
|
32 |
|
33 clean: |
|
34 rm -rf apidoc/ |
|
35 rm -f *.html |
|
36 -rm -rf build/* |
|
37 |
|
38 all: ${TARGET} apidoc html |
|
39 |
|
40 %.html: %.txt |
|
41 ${MKHTML} ${MKHTMLOPTS} $< |
|
42 |
|
43 #apydoc: |
|
44 # epydoc --html -o epydoc/ -n ../server/*.py ../core/*.py ../common/*.py ../server/*/*.py ../modpython/*/*.py ../common/*/*.py |
|
45 apidoc: |
|
46 epydoc --html -o apidoc -n "cubicweb" --exclude=setup --exclude=__pkginfo__ ../../../ |
|
47 |
|
48 # run sphinx ### |
|
49 html: |
|
50 mkdir -p build/html build/doctrees |
|
51 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html |
|
52 @echo |
|
53 @echo "Build finished. The HTML pages are in build/html." |
|
54 |
|
55 pickle: |
|
56 mkdir -p build/pickle build/doctrees |
|
57 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle |
|
58 @echo |
|
59 @echo "Build finished; now you can process the pickle files or run" |
|
60 @echo " sphinx-web build/pickle" |
|
61 @echo "to start the sphinx-web server." |
|
62 |
|
63 web: pickle |
|
64 |
|
65 htmlhelp: |
|
66 mkdir -p build/htmlhelp build/doctrees |
|
67 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp |
|
68 @echo |
|
69 @echo "Build finished; now you can run HTML Help Workshop with the" \ |
|
70 ".hhp project file in build/htmlhelp." |
|
71 |
|
72 latex: |
|
73 mkdir -p build/latex build/doctrees |
|
74 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex |
|
75 @echo |
|
76 @echo "Build finished; the LaTeX files are in build/latex." |
|
77 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
|
78 "run these through (pdf)latex." |
|
79 |
|
80 changes: |
|
81 mkdir -p build/changes build/doctrees |
|
82 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes |
|
83 @echo |
|
84 @echo "The overview file is in build/changes." |
|
85 |
|
86 linkcheck: |
|
87 mkdir -p build/linkcheck build/doctrees |
|
88 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck |
|
89 @echo |
|
90 @echo "Link check complete; look for any errors in the above output " \ |
|
91 "or in build/linkcheck/output.txt." |
|