Debian Codegraph @

docs/Makefile

raw
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 #BUILDDIR = ../../gpyfft-docs
9 BUILDDIR = build
10 #PDFBUILDDIR = /tmp
11 PDFBUILDDIR = build
12 #PDF = ../manual.pdf
13 PDF = manual.pdf
14
15
16 # Internal variables.
17 PAPEROPT_a4 = -D latex_paper_size=a4
18 PAPEROPT_letter = -D latex_paper_size=letter
19 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
20 # the i18n builder cannot share the environment and doctrees with the others
21 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
22
23 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
24
25 help:
26 @echo "Please use \`make <target>' where <target> is one of"
27 @echo " html to make standalone HTML files"
28 @echo " dirhtml to make HTML files named index.html in directories"
29 @echo " singlehtml to make a single large HTML file"
30 @echo " pickle to make pickle files"
31 @echo " json to make JSON files"
32 @echo " htmlhelp to make HTML files and a HTML help project"
33 @echo " qthelp to make HTML files and a qthelp project"
34 @echo " devhelp to make HTML files and a Devhelp project"
35 @echo " epub to make an epub"
36 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
37 @echo " latexpdf to make LaTeX files and run them through pdflatex"
38 @echo " text to make text files"
39 @echo " man to make manual pages"
40 @echo " texinfo to make Texinfo files"
41 @echo " info to make Texinfo files and run them through makeinfo"
42 @echo " gettext to make PO message catalogs"
43 @echo " changes to make an overview of all changed/added/deprecated items"
44 @echo " linkcheck to check all external links for integrity"
45 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
46
47 clean:
48 -rm -rf $(BUILDDIR)/*
49
50 html:
51 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
52 @echo
53 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
54
55 dirhtml:
56 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
57 @echo
58 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
59
60 singlehtml:
61 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
62 @echo
63 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
64
65 pickle:
66 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
67 @echo
68 @echo "Build finished; now you can process the pickle files."
69
70 json:
71 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
72 @echo
73 @echo "Build finished; now you can process the JSON files."
74
75 htmlhelp:
76 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
77 @echo
78 @echo "Build finished; now you can run HTML Help Workshop with the" \
79 ".hhp project file in $(BUILDDIR)/htmlhelp."
80
81 qthelp:
82 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
83 @echo
84 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
85 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
86 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/gpyfft.qhcp"
87 @echo "To view the help file:"
88 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gpyfft.qhc"
89
90 devhelp:
91 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
92 @echo
93 @echo "Build finished."
94 @echo "To view the help file:"
95 @echo "# mkdir -p $$HOME/.local/share/devhelp/gpyfft"
96 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gpyfft"
97 @echo "# devhelp"
98
99 epub:
100 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
101 @echo
102 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
103
104 latex:
105 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
106 @echo
107 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
108 @echo "Run \`make' in that directory to run these through (pdf)latex" \
109 "(use \`make latexpdf' here to do that automatically)."
110
111 latexpdf:
112 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(PDFBUILDDIR)/latex
113 @echo "Running LaTeX files through pdflatex..."
114 $(MAKE) -C $(PDFBUILDDIR)/latex all-pdf
115 cp $(PDFBUILDDIR)/latex/*.pdf $(PDF)
116 @echo "pdflatex finished; the PDF files are in $(PDFBUILDDIR)/latex."
117
118 text:
119 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
120 @echo
121 @echo "Build finished. The text files are in $(BUILDDIR)/text."
122
123 man:
124 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
125 @echo
126 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
127
128 texinfo:
129 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130 @echo
131 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
132 @echo "Run \`make' in that directory to run these through makeinfo" \
133 "(use \`make info' here to do that automatically)."
134
135 info:
136 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137 @echo "Running Texinfo files through makeinfo..."
138 make -C $(BUILDDIR)/texinfo info
139 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
140
141 gettext:
142 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
143 @echo
144 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
145
146 changes:
147 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
148 @echo
149 @echo "The overview file is in $(BUILDDIR)/changes."
150
151 linkcheck:
152 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
153 @echo
154 @echo "Link check complete; look for any errors in the above output " \
155 "or in $(BUILDDIR)/linkcheck/output.txt."
156
157 doctest:
158 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
159 @echo "Testing of doctests in the sources finished, look at the " \
160 "results in $(BUILDDIR)/doctest/output.txt."