Statistics
| Branch: | Tag: | Revision:

root / docs / Makefile @ a1d0bacb

History | View | Annotate | Download (5.4 kB)

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