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