Statistics
| Branch: | Revision:

root / docs / Makefile @ be350355

History | View | Annotate | Download (5.4 kB)

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