|
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 | | -PAPEROPT_a4 = -D latex_paper_size=a4 |
11 | | -PAPEROPT_letter = -D latex_paper_size=letter |
12 | | -ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source |
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 " apidoc to run epydoc" |
20 | | - @echo " pickle to make pickle files" |
21 | | - @echo " json to make JSON files" |
22 | | - @echo " htmlhelp to make HTML files and a HTML help project" |
23 | | - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
24 | | - @echo " changes to make an overview over all changed/added/deprecated items" |
25 | | - @echo " linkcheck to check all external links for integrity" |
26 | | - |
27 | | -clean: |
28 | | - -rm -rf docbuild/* |
29 | | - |
30 | | -html: |
31 | | - mkdir -p build/html build/doctrees |
32 | | - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) docbuild/html |
33 | | - @echo |
34 | | - @echo "Build finished. The HTML pages are in docbuild/html." |
35 | | - |
36 | | -apidoc: |
37 | | - mkdir -p build/html/apidoc |
38 | | - epydoc-2.6 --docformat restructuredtext ../lib/bx -o docbuild/html/apidoc |
39 | | - @echo |
40 | | - @echo "Epydoc finished. The pages are in docbuild/html/apidoc." |
41 | | - |
42 | | - |
43 | | -pickle: |
44 | | - mkdir -p build/pickle build/doctrees |
45 | | - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) docbuild/pickle |
46 | | - @echo |
47 | | - @echo "Build finished; now you can process the pickle files." |
48 | | - |
49 | | -web: pickle |
50 | | - |
51 | | -json: |
52 | | - mkdir -p build/json build/doctrees |
53 | | - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) docbuild/json |
54 | | - @echo |
55 | | - @echo "Build finished; now you can process the JSON files." |
56 | | - |
57 | | -htmlhelp: |
58 | | - mkdir -p build/htmlhelp build/doctrees |
59 | | - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) docbuild/htmlhelp |
60 | | - @echo |
61 | | - @echo "Build finished; now you can run HTML Help Workshop with the" \ |
62 | | - ".hhp project file in build/htmlhelp." |
63 | | - |
64 | | -latex: |
65 | | - mkdir -p build/latex build/doctrees |
66 | | - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) docbuild/latex |
67 | | - @echo |
68 | | - @echo "Build finished; the LaTeX files are in build/latex." |
69 | | - @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
70 | | - "run these through (pdf)latex." |
71 | | - |
72 | | -changes: |
73 | | - mkdir -p build/changes build/doctrees |
74 | | - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) docbuild/changes |
75 | | - @echo |
76 | | - @echo "The overview file is in build/changes." |
77 | | - |
78 | | -linkcheck: |
79 | | - mkdir -p build/linkcheck build/doctrees |
80 | | - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) docbuild/linkcheck |
81 | | - @echo |
82 | | - @echo "Link check complete; look for any errors in the above output " \ |
83 | | - "or in build/linkcheck/output.txt." |
| 1 | +# Minimal makefile for Sphinx documentation |
| 2 | +# |
| 3 | + |
| 4 | +# You can set these variables from the command line, and also |
| 5 | +# from the environment for the first two. |
| 6 | +SPHINXOPTS ?= |
| 7 | +SPHINXBUILD ?= sphinx-build |
| 8 | +SOURCEDIR = source |
| 9 | +BUILDDIR = build |
| 10 | + |
| 11 | +# Put it first so that "make" without argument is like "make help". |
| 12 | +help: |
| 13 | + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
| 14 | + |
| 15 | +.PHONY: help Makefile |
| 16 | + |
| 17 | +# Catch-all target: route all unknown targets to Sphinx using the new |
| 18 | +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). |
| 19 | +%: Makefile |
| 20 | + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
0 commit comments