]> git.donarmstrong.com Git - neurodebian.git/blob - Makefile
Initial (crude) but somewhat functional state.
[neurodebian.git] / Makefile
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 SRCDIR = build/source
11 PAPEROPT_a4     = -D latex_paper_size=a4
12 PAPEROPT_letter = -D latex_paper_size=letter
13 ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
14
15
16 WWW_UPLOAD_URI = elrond:/home/hanke/public_html/archive
17 WWW_DIR = build/html
18
19
20 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck
21
22
23 prep:
24         mkdir -p build
25         cp -r source build/
26
27
28 clean:
29         -rm -rf build
30
31 html: prep
32         mkdir -p build/html build/doctrees
33         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
34         @echo
35         @echo "Build finished. The HTML pages are in build/html."
36
37 pickle: prep
38         mkdir -p build/pickle build/doctrees
39         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
40         @echo
41         @echo "Build finished; now you can process the pickle files."
42
43 web: pickle
44
45 json: prep
46         mkdir -p build/json build/doctrees
47         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
48         @echo
49         @echo "Build finished; now you can process the JSON files."
50
51 htmlhelp: prep
52         mkdir -p build/htmlhelp build/doctrees
53         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
54         @echo
55         @echo "Build finished; now you can run HTML Help Workshop with the" \
56               ".hhp project file in build/htmlhelp."
57
58 latex: prep
59         mkdir -p build/latex build/doctrees
60         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
61         @echo
62         @echo "Build finished; the LaTeX files are in build/latex."
63         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
64               "run these through (pdf)latex."
65
66 changes: prep
67         mkdir -p build/changes build/doctrees
68         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
69         @echo
70         @echo "The overview file is in build/changes."
71
72 linkcheck: prep
73         mkdir -p build/linkcheck build/doctrees
74         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
75         @echo
76         @echo "Link check complete; look for any errors in the above output " \
77         "or in build/linkcheck/output.txt."
78
79
80 update-db:
81         python deb2rst/archive.py
82
83
84 upload-website: html
85         rsync -rvzlhp --delete --chmod=Dg+s,g+rw $(WWW_DIR) $(WWW_UPLOAD_URI)