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