source: sasview/docs/sphinx-docs/Makefile @ 49148bb

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 49148bb was c23de6a, checked in by Paul Kienzle <pkienzle@…>, 9 years ago

fix sphinx Makefile to use same api directory as build_sphinx.py

  • Property mode set to 100644
File size: 6.7 KB
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# User-friendly check for sphinx-build
11ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13endif
14
15# Internal variables.
16PAPEROPT_a4     = -D latex_paper_size=a4
17PAPEROPT_letter = -D latex_paper_size=letter
18ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19# the i18n builder cannot share the environment and doctrees with the others
20I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21
22.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23
24help:
25        @echo "Please use \`make <target>' where <target> is one of"
26        @echo "  html       to make standalone HTML files"
27        @echo "  dirhtml    to make HTML files named index.html in directories"
28        @echo "  singlehtml to make a single large HTML file"
29        @echo "  pickle     to make pickle files"
30        @echo "  json       to make JSON files"
31        @echo "  htmlhelp   to make HTML files and a HTML help project"
32        @echo "  qthelp     to make HTML files and a qthelp project"
33        @echo "  devhelp    to make HTML files and a Devhelp project"
34        @echo "  epub       to make an epub"
35        @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36        @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
37        @echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38        @echo "  text       to make text files"
39        @echo "  man        to make manual pages"
40        @echo "  texinfo    to make Texinfo files"
41        @echo "  info       to make Texinfo files and run them through makeinfo"
42        @echo "  gettext    to make PO message catalogs"
43        @echo "  changes    to make an overview of all changed/added/deprecated items"
44        @echo "  xml        to make Docutils-native XML files"
45        @echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
46        @echo "  linkcheck  to check all external links for integrity"
47        @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
48
49clean:
50        rm -rf $(BUILDDIR)/*
51
52stubs:
53        rm -rf source/dev/api
54        sphinx-apidoc -o source/dev/api -d 8 ../../src
55       
56html: stubs
57        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
58        @echo
59        @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
60
61dirhtml:
62        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
63        @echo
64        @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
65
66singlehtml:
67        $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
68        @echo
69        @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
70
71pickle:
72        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
73        @echo
74        @echo "Build finished; now you can process the pickle files."
75
76json:
77        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
78        @echo
79        @echo "Build finished; now you can process the JSON files."
80
81htmlhelp:
82        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
83        @echo
84        @echo "Build finished; now you can run HTML Help Workshop with the" \
85              ".hhp project file in $(BUILDDIR)/htmlhelp."
86
87qthelp:
88        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
89        @echo
90        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
91              ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
92        @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SasView.qhcp"
93        @echo "To view the help file:"
94        @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SasView.qhc"
95
96devhelp:
97        $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
98        @echo
99        @echo "Build finished."
100        @echo "To view the help file:"
101        @echo "# mkdir -p $$HOME/.local/share/devhelp/SasView"
102        @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SasView"
103        @echo "# devhelp"
104
105epub:
106        $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
107        @echo
108        @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
109
110latex:
111        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
112        @echo
113        @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
114        @echo "Run \`make' in that directory to run these through (pdf)latex" \
115              "(use \`make latexpdf' here to do that automatically)."
116
117latexpdf:
118        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
119        @echo "Running LaTeX files through pdflatex..."
120        $(MAKE) -C $(BUILDDIR)/latex all-pdf
121        @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
122
123latexpdfja:
124        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
125        @echo "Running LaTeX files through platex and dvipdfmx..."
126        $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
127        @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
128
129text:
130        $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
131        @echo
132        @echo "Build finished. The text files are in $(BUILDDIR)/text."
133
134man:
135        $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
136        @echo
137        @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
138
139texinfo:
140        $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
141        @echo
142        @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
143        @echo "Run \`make' in that directory to run these through makeinfo" \
144              "(use \`make info' here to do that automatically)."
145
146info:
147        $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
148        @echo "Running Texinfo files through makeinfo..."
149        make -C $(BUILDDIR)/texinfo info
150        @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
151
152gettext:
153        $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
154        @echo
155        @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
156
157changes:
158        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
159        @echo
160        @echo "The overview file is in $(BUILDDIR)/changes."
161
162linkcheck:
163        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
164        @echo
165        @echo "Link check complete; look for any errors in the above output " \
166              "or in $(BUILDDIR)/linkcheck/output.txt."
167
168doctest:
169        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
170        @echo "Testing of doctests in the sources finished, look at the " \
171              "results in $(BUILDDIR)/doctest/output.txt."
172
173xml:
174        $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
175        @echo
176        @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
177
178pseudoxml:
179        $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
180        @echo
181        @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
Note: See TracBrowser for help on using the repository browser.