source: orange/docs/development/Makefile @ 10437:f67be979793c

Revision 10437:f67be979793c, 3.1 KB checked in by mitar, 2 years ago (diff)

Added documentation for library development.

Line 
1# Makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS    =
6SPHINXBUILD   = sphinx-build
7PAPER         =
8
9# Internal variables.
10PAPEROPT_a4     = -D latex_paper_size=a4
11PAPEROPT_letter = -D latex_paper_size=letter
12#ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
13ALLSPHINXOPTS   = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) rst
14
15.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
16
17help:
18    @echo "Please use \`make <target>' where <target> is one of"
19    @echo "  html      to make standalone HTML files"
20    @echo "  dirhtml   to make HTML files named index.html in directories"
21    @echo "  epub      to make epub file"
22    @echo "  pickle    to make pickle files"
23    @echo "  json      to make JSON files"
24    @echo "  htmlhelp  to make HTML files and a HTML help project"
25    @echo "  qthelp    to make HTML files and a qthelp project"
26    @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
27    @echo "  changes   to make an overview of all changed/added/deprecated items"
28    @echo "  linkcheck to check all external links for integrity"
29    @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
30
31clean:
32    -rm -rf _* *.html html .doctrees .buildinfo searchindex.js *.epub epub rst/_build
33
34epub:
35    $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) epub
36    mv epub/*.epub .
37    @echo
38    @echo "Build finished. The epub pages are in "
39
40html:
41    $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) html
42    @echo
43    @echo "Build finished. The HTML pages are in .. ."
44
45dirhtml:
46    $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) .dirhtml
47    @echo
48    @echo "Build finished. The HTML pages are in .dirhtml."
49
50pickle:
51    $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .pickle
52    @echo
53    @echo "Build finished; now you can process the pickle files."
54
55json:
56    $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) .json
57    @echo
58    @echo "Build finished; now you can process the JSON files."
59
60htmlhelp:
61    $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .htmlhelp
62    @echo
63    @echo "Build finished; now you can run HTML Help Workshop with the" \
64          ".hhp project file in .htmlhelp."
65
66qthelp:
67    $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) .qthelp
68    @echo
69    @echo "Build finished; now you can run "qcollectiongenerator" with the" \
70          ".qhcp project file in .qthelp, like this:"
71    @echo "# qcollectiongenerator .qthelp/OrangeWidgetCatalog.qhcp"
72    @echo "To view the help file:"
73    @echo "# assistant -collectionFile .qthelp/OrangeWidgetCatalog.qhc"
74
75latex:
76    $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .latex
77    @echo
78    @echo "Build finished; the LaTeX files are in .latex."
79    @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
80          "run these through (pdf)latex."
81
82changes:
83    $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .changes
84    @echo
85    @echo "The overview file is in .changes."
86
87linkcheck:
88    $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .linkcheck
89    @echo
90    @echo "Link check complete; look for any errors in the above output " \
91          "or in .linkcheck/output.txt."
92
93doctest:
94    $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) .doctest
95    @echo "Testing of doctests in the sources finished, look at the " \
96          "results in .doctest/output.txt."
Note: See TracBrowser for help on using the repository browser.