Statistics
| Branch: | Tag: | Revision:

root / docs / Makefile @ 126f8f4e

History | View | Annotate | Download (5.5 kB)

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