source: 1dwg/tags/v1.1/doc/Makefile @ 336

Last change on this file since 336 was 336, checked in by prjemian, 6 years ago

#34: this is the v1.1 release

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision Url
File size: 6.0 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# change this for new releases
18PDF_NAME = cansas-1d-1_1-manual.pdf
19
20.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext rebuild rebuild-html all realclean
21
22help:
23        @echo "Please use \`make <target>' where <target> is one of"
24        @echo "  html       to make standalone HTML files"
25        @echo "  dirhtml    to make HTML files named index.html in directories"
26        @echo "  singlehtml to make a single large HTML file"
27        @echo "  pickle     to make pickle files"
28        @echo "  json       to make JSON files"
29        @echo "  htmlhelp   to make HTML files and a HTML help project"
30        @echo "  qthelp     to make HTML files and a qthelp project"
31        @echo "  devhelp    to make HTML files and a Devhelp project"
32        @echo "  epub       to make an epub"
33        @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
34        @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
35        @echo "  text       to make text files"
36        @echo "  man        to make manual pages"
37        @echo "  texinfo    to make Texinfo files"
38        @echo "  info       to make Texinfo files and run them through makeinfo"
39        @echo "  gettext    to make PO message catalogs"
40        @echo "  changes    to make an overview of all changed/added/deprecated items"
41        @echo "  linkcheck  to check all external links for integrity"
42        @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
43        @echo "  rebuild    to rebuild latexpdf and html"
44        @echo "  rebuild-html    to rebuild only html"
45        @echo "  all        to build latexpdf and html"
46        @echo "  clean      remove build/doctrees (forces a complete build next time)"
47        @echo "  realclean  remove build/*"
48
49clean:
50        -rm -rf $(BUILDDIR)/doctrees
51
52realclean:
53        -rm -rf $(BUILDDIR)/*
54
55html:
56        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
57        @echo
58        @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
59
60dirhtml:
61        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
62        @echo
63        @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
64
65singlehtml:
66        $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
67        @echo
68        @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
69
70pickle:
71        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
72        @echo
73        @echo "Build finished; now you can process the pickle files."
74
75json:
76        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
77        @echo
78        @echo "Build finished; now you can process the JSON files."
79
80htmlhelp:
81        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
82        @echo
83        @echo "Build finished; now you can run HTML Help Workshop with the" \
84              ".hhp project file in $(BUILDDIR)/htmlhelp."
85
86qthelp:
87        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
88        @echo
89        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
90              ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
91        @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/canSAS1d.qhcp"
92        @echo "To view the help file:"
93        @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/canSAS1d.qhc"
94
95devhelp:
96        $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
97        @echo
98        @echo "Build finished."
99        @echo "To view the help file:"
100        @echo "# mkdir -p $$HOME/.local/share/devhelp/canSAS1d"
101        @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/canSAS1d"
102        @echo "# devhelp"
103
104epub:
105        $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
106        @echo
107        @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
108
109latex:
110        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
111        @echo
112        @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
113        @echo "Run \`make' in that directory to run these through (pdf)latex" \
114              "(use \`make latexpdf' here to do that automatically)."
115
116latexpdf:
117        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
118        @echo "Running LaTeX files through pdflatex..."
119        $(MAKE) -C $(BUILDDIR)/latex all-pdf
120        /bin/cp -f $(BUILDDIR)/latex/canSAS1d.pdf ./$(PDF_NAME)
121        @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
122
123text:
124        $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
125        @echo
126        @echo "Build finished. The text files are in $(BUILDDIR)/text."
127
128man:
129        $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
130        @echo
131        @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
132
133texinfo:
134        $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
135        @echo
136        @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
137        @echo "Run \`make' in that directory to run these through makeinfo" \
138              "(use \`make info' here to do that automatically)."
139
140info:
141        $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
142        @echo "Running Texinfo files through makeinfo..."
143        make -C $(BUILDDIR)/texinfo info
144        @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
145
146gettext:
147        $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
148        @echo
149        @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
150
151changes:
152        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
153        @echo
154        @echo "The overview file is in $(BUILDDIR)/changes."
155
156linkcheck:
157        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
158        @echo
159        @echo "Link check complete; look for any errors in the above output " \
160              "or in $(BUILDDIR)/linkcheck/output.txt."
161
162doctest:
163        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
164        @echo "Testing of doctests in the sources finished, look at the " \
165              "results in $(BUILDDIR)/doctest/output.txt."
166
167all: latexpdf html
168
169rebuild-html: clean html
170
171rebuild: clean all
Note: See TracBrowser for help on using the repository browser.