source: orange/docs/Makefile @ 11028:009ba5a75e30

Revision 11028:009ba5a75e30, 5.4 KB checked in by Miha Stajdohar <miha.stajdohar@…>, 17 months ago (diff)

Added a common documentation index.

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