source: APSpy/trunk/docs/Makefile @ 1337

Last change on this file since 1337 was 1337, checked in by jemian, 9 years ago

refs #2

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision Url
File size: 5.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# Internal variables.
11PAPEROPT_a4     = -D latex_paper_size=a4
12PAPEROPT_letter = -D latex_paper_size=letter
13ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14# the i18n builder cannot share the environment and doctrees with the others
15I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
16
17.PHONY: help clean realclean rebuild all 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        rm -f $(BUILDDIR)/doctrees/*
44
45realclean:
46        #-rm -rf $(BUILDDIR)/*
47        rm $(BUILDDIR)/doctrees/* $(BUILDDIR)/html/*.html $(BUILDDIR)/html/*/*.html $(BUILDDIR)/latex
48
49rebuild:  clean all
50
51all: latexpdf  html
52
53html:
54        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
55        @echo
56        @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
57
58dirhtml:
59        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
60        @echo
61        @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
62
63singlehtml:
64        $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
65        @echo
66        @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
67
68pickle:
69        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
70        @echo
71        @echo "Build finished; now you can process the pickle files."
72
73json:
74        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
75        @echo
76        @echo "Build finished; now you can process the JSON files."
77
78htmlhelp:
79        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
80        @echo
81        @echo "Build finished; now you can run HTML Help Workshop with the" \
82              ".hhp project file in $(BUILDDIR)/htmlhelp."
83
84qthelp:
85        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
86        @echo
87        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
88              ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
89        @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/APSpy.qhcp"
90        @echo "To view the help file:"
91        @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/APSpy.qhc"
92
93devhelp:
94        $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
95        @echo
96        @echo "Build finished."
97        @echo "To view the help file:"
98        @echo "# mkdir -p $$HOME/.local/share/devhelp/APSpy"
99        @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/APSpy"
100        @echo "# devhelp"
101
102epub:
103        $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
104        @echo
105        @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
106
107latex:
108        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
109        @echo
110        @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
111        @echo "Run \`make' in that directory to run these through (pdf)latex" \
112              "(use \`make latexpdf' here to do that automatically)."
113
114latexpdf:
115        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
116        @echo "Running LaTeX files through pdflatex..."
117        $(MAKE) -C $(BUILDDIR)/latex all-pdf
118        /bin/mv -f $(BUILDDIR)/latex/APSpy.pdf ./
119        @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
120
121text:
122        $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
123        @echo
124        @echo "Build finished. The text files are in $(BUILDDIR)/text."
125
126man:
127        $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
128        @echo
129        @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
130
131texinfo:
132        $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
133        @echo
134        @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
135        @echo "Run \`make' in that directory to run these through makeinfo" \
136              "(use \`make info' here to do that automatically)."
137
138info:
139        $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
140        @echo "Running Texinfo files through makeinfo..."
141        make -C $(BUILDDIR)/texinfo info
142        @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
143
144gettext:
145        $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
146        @echo
147        @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
148
149changes:
150        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
151        @echo
152        @echo "The overview file is in $(BUILDDIR)/changes."
153
154linkcheck:
155        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
156        @echo
157        @echo "Link check complete; look for any errors in the above output " \
158              "or in $(BUILDDIR)/linkcheck/output.txt."
159
160doctest:
161        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
162        @echo "Testing of doctests in the sources finished, look at the " \
163              "results in $(BUILDDIR)/doctest/output.txt."
Note: See TracBrowser for help on using the repository browser.