root / docs / Makefile @ 4b93a247
History | View | Annotate | Download (2.9 kB)
1 | 216bb34c | Shikhar Bhushan | # Makefile for Sphinx documentation |
---|---|---|---|
2 | 216bb34c | Shikhar Bhushan | # |
3 | 216bb34c | Shikhar Bhushan | |
4 | 216bb34c | Shikhar Bhushan | # You can set these variables from the command line. |
5 | 216bb34c | Shikhar Bhushan | SPHINXOPTS = |
6 | 216bb34c | Shikhar Bhushan | SPHINXBUILD = sphinx-build |
7 | 216bb34c | Shikhar Bhushan | PAPER = |
8 | 216bb34c | Shikhar Bhushan | |
9 | 216bb34c | Shikhar Bhushan | # Internal variables. |
10 | 216bb34c | Shikhar Bhushan | PAPEROPT_a4 = -D latex_paper_size=a4 |
11 | 216bb34c | Shikhar Bhushan | PAPEROPT_letter = -D latex_paper_size=letter |
12 | 216bb34c | Shikhar Bhushan | ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source |
13 | 216bb34c | Shikhar Bhushan | |
14 | 216bb34c | Shikhar Bhushan | .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest |
15 | 216bb34c | Shikhar Bhushan | |
16 | 216bb34c | Shikhar Bhushan | help: |
17 | 216bb34c | Shikhar Bhushan | @echo "Please use \`make <target>' where <target> is one of" |
18 | 216bb34c | Shikhar Bhushan | @echo " html to make standalone HTML files" |
19 | 216bb34c | Shikhar Bhushan | @echo " dirhtml to make HTML files named index.html in directories" |
20 | 216bb34c | Shikhar Bhushan | @echo " pickle to make pickle files" |
21 | 216bb34c | Shikhar Bhushan | @echo " json to make JSON files" |
22 | 216bb34c | Shikhar Bhushan | @echo " htmlhelp to make HTML files and a HTML help project" |
23 | 216bb34c | Shikhar Bhushan | @echo " qthelp to make HTML files and a qthelp project" |
24 | 216bb34c | Shikhar Bhushan | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
25 | 216bb34c | Shikhar Bhushan | @echo " changes to make an overview of all changed/added/deprecated items" |
26 | 216bb34c | Shikhar Bhushan | @echo " linkcheck to check all external links for integrity" |
27 | 216bb34c | Shikhar Bhushan | @echo " doctest to run all doctests embedded in the documentation (if enabled)" |
28 | 216bb34c | Shikhar Bhushan | |
29 | 216bb34c | Shikhar Bhushan | clean: |
30 | 216bb34c | Shikhar Bhushan | -rm -rf build/* |
31 | 216bb34c | Shikhar Bhushan | |
32 | 216bb34c | Shikhar Bhushan | html: |
33 | 216bb34c | Shikhar Bhushan | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html |
34 | 216bb34c | Shikhar Bhushan | @echo |
35 | 216bb34c | Shikhar Bhushan | @echo "Build finished. The HTML pages are in build/html." |
36 | 216bb34c | Shikhar Bhushan | |
37 | 216bb34c | Shikhar Bhushan | dirhtml: |
38 | 216bb34c | Shikhar Bhushan | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml |
39 | 216bb34c | Shikhar Bhushan | @echo |
40 | 216bb34c | Shikhar Bhushan | @echo "Build finished. The HTML pages are in build/dirhtml." |
41 | 216bb34c | Shikhar Bhushan | |
42 | 216bb34c | Shikhar Bhushan | pickle: |
43 | 216bb34c | Shikhar Bhushan | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle |
44 | 216bb34c | Shikhar Bhushan | @echo |
45 | 216bb34c | Shikhar Bhushan | @echo "Build finished; now you can process the pickle files." |
46 | 216bb34c | Shikhar Bhushan | |
47 | 216bb34c | Shikhar Bhushan | json: |
48 | 216bb34c | Shikhar Bhushan | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json |
49 | 216bb34c | Shikhar Bhushan | @echo |
50 | 216bb34c | Shikhar Bhushan | @echo "Build finished; now you can process the JSON files." |
51 | 216bb34c | Shikhar Bhushan | |
52 | 216bb34c | Shikhar Bhushan | htmlhelp: |
53 | 216bb34c | Shikhar Bhushan | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp |
54 | 216bb34c | Shikhar Bhushan | @echo |
55 | 216bb34c | Shikhar Bhushan | @echo "Build finished; now you can run HTML Help Workshop with the" \ |
56 | 216bb34c | Shikhar Bhushan | ".hhp project file in build/htmlhelp." |
57 | 216bb34c | Shikhar Bhushan | |
58 | 216bb34c | Shikhar Bhushan | qthelp: |
59 | 216bb34c | Shikhar Bhushan | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp |
60 | 216bb34c | Shikhar Bhushan | @echo |
61 | 216bb34c | Shikhar Bhushan | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
62 | 216bb34c | Shikhar Bhushan | ".qhcp project file in build/qthelp, like this:" |
63 | 216bb34c | Shikhar Bhushan | @echo "# qcollectiongenerator build/qthelp/ncclient.qhcp" |
64 | 216bb34c | Shikhar Bhushan | @echo "To view the help file:" |
65 | 216bb34c | Shikhar Bhushan | @echo "# assistant -collectionFile build/qthelp/ncclient.qhc" |
66 | 216bb34c | Shikhar Bhushan | |
67 | 216bb34c | Shikhar Bhushan | latex: |
68 | 216bb34c | Shikhar Bhushan | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex |
69 | 216bb34c | Shikhar Bhushan | @echo |
70 | 216bb34c | Shikhar Bhushan | @echo "Build finished; the LaTeX files are in build/latex." |
71 | 216bb34c | Shikhar Bhushan | @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
72 | 216bb34c | Shikhar Bhushan | "run these through (pdf)latex." |
73 | 216bb34c | Shikhar Bhushan | |
74 | 216bb34c | Shikhar Bhushan | changes: |
75 | 216bb34c | Shikhar Bhushan | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes |
76 | 216bb34c | Shikhar Bhushan | @echo |
77 | 216bb34c | Shikhar Bhushan | @echo "The overview file is in build/changes." |
78 | 216bb34c | Shikhar Bhushan | |
79 | 216bb34c | Shikhar Bhushan | linkcheck: |
80 | 216bb34c | Shikhar Bhushan | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck |
81 | 216bb34c | Shikhar Bhushan | @echo |
82 | 216bb34c | Shikhar Bhushan | @echo "Link check complete; look for any errors in the above output " \ |
83 | 216bb34c | Shikhar Bhushan | "or in build/linkcheck/output.txt." |
84 | 216bb34c | Shikhar Bhushan | |
85 | 216bb34c | Shikhar Bhushan | doctest: |
86 | 216bb34c | Shikhar Bhushan | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest |
87 | 216bb34c | Shikhar Bhushan | @echo "Testing of doctests in the sources finished, look at the " \ |
88 | 216bb34c | Shikhar Bhushan | "results in build/doctest/output.txt." |