source: trunk/docs/docs_dev/Makefile @ 518

Last change on this file since 518 was 518, checked in by pinsard, 12 years ago

consolidation of doc dev.
File size: 5.7 KB
Line 
1#+
2#
3# .. _Makefile:
4#
5# ========
6# Makefile
7# ========
8#
9# DESCRIPTION
10# ===========
11#
12# Makefile for Sphinx documentation
13#
14# SEE ALSO
15# ========
16#
17# :ref:`builddoc`
18#
19# :ref:`makefile_non_sphinx`
20#
21# TODO
22# ====
23#
24# moins bourrin dans l'usage de makefile_non_sphinx et la génération du
25# logo
26#
27#
28# EVOLUTIONS
29# ==========
30#
31# $Id: Makefile 30 2012-03-13 10:53:33Z pinsard $
32#
33# $URL: svn+ssh://pinsard@forge.ipsl.jussieu.fr/ipsl/forge/projets/fptools/svn/trunk/docs/docs_dev/Makefile $
34#
35# - fplod 20120413
36#
37#   * update whith new sphinx backend
38#
39# - fplod 20120413T082638Z cratos (Linux)
40#
41#   * add header
42#-
43
44#
45# You can set these variables from the command line.
46SPHINXOPTS    =
47SPHINXBUILD   = sphinx-build
48PAPER         =
49BUILDDIR      = ../../doc/
50
51# Internal variables.
52PAPEROPT_a4     = -D latex_paper_size=a4
53PAPEROPT_letter = -D latex_paper_size=letter
54ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
55
56.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
57
58help:
59        @echo "Please use \`make <target>' where <target> is one of"
60        @echo "Please use \`make <target>' where <target> is one of"
61        @echo "  html       to make standalone HTML files"
62        @echo "  dirhtml    to make HTML files named index.html in directories"
63        @echo "  singlehtml to make a single large HTML file"
64        @echo "  pickle     to make pickle files"
65        @echo "  json       to make JSON files"
66        @echo "  htmlhelp   to make HTML files and a HTML help project"
67        @echo "  qthelp     to make HTML files and a qthelp project"
68        @echo "  devhelp    to make HTML files and a Devhelp project"
69        @echo "  epub       to make an epub"
70        @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
71        @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
72        @echo "  text       to make text files"
73        @echo "  man        to make manual pages"
74        @echo "  changes    to make an overview of all changed/added/deprecated items"
75        @echo "  linkcheck  to check all external links for integrity"
76        @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
77
78clean:
79        @make -f makefile_non_sphinx clean
80        -rm -rf $(BUILDDIR)/*
81
82html:
83        @make -f makefile_non_sphinx all
84        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
85        @echo
86        @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
87
88dirhtml:
89        @make -f makefile_non_sphinx all
90        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
91        @echo
92        @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
93
94singlehtml:
95        @make -f makefile_non_sphinx all
96        $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
97        @echo
98        @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
99
100pickle:
101        @make -f makefile_non_sphinx all
102        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
103        @echo
104        @echo "Build finished; now you can process the pickle files."
105
106json:
107        @make -f makefile_non_sphinx all
108        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
109        @echo
110        @echo "Build finished; now you can process the JSON files."
111
112htmlhelp:
113        @make -f makefile_non_sphinx all
114        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
115        @echo
116        @echo "Build finished; now you can run HTML Help Workshop with the" \
117              ".hhp project file in $(BUILDDIR)/htmlhelp."
118
119qthelp:
120        @make -f makefile_non_sphinx all
121        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
122        @echo
123        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
124              ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
125        @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/VARAMMA.qhcp"
126        @echo "To view the help file:"
127        @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/VARAMMA.qhc"
128devhelp:
129        @make -f makefile_non_sphinx all
130        $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
131        @echo
132        @echo "Build finished."
133        @echo "To view the help file:"
134        @echo "# mkdir -p $$HOME/.local/share/devhelp/TROPFLUX"
135        @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TROPFLUX"
136        @echo "# devhelp"
137
138epub:
139        @make -f makefile_non_sphinx all
140        $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
141        @echo
142        @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
143
144latex:
145        @make -f makefile_non_sphinx all
146        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
147        @echo
148        @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
149        @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
150              "run these through (pdf)latex."
151
152latexpdf:
153        @make -f makefile_non_sphinx all
154        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
155        @echo "Running LaTeX files through pdflatex..."
156        make -C $(BUILDDIR)/latex all-pdf
157        @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
158
159text:
160        @make -f makefile_non_sphinx all
161        $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
162        @echo
163        @echo "Build finished. The text files are in $(BUILDDIR)/text."
164
165man:
166        @make -f makefile_non_sphinx all
167        $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
168        @echo
169        @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
170
171changes:
172        @make -f makefile_non_sphinx all
173        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
174        @echo
175        @echo "The overview file is in $(BUILDDIR)/changes."
176
177linkcheck:
178        @make -f makefile_non_sphinx all
179        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
180        @echo
181        @echo "Link check complete; look for any errors in the above output " \
182              "or in $(BUILDDIR)/linkcheck/output.txt."
183
184doctest:
185        @make -f makefile_non_sphinx all
186        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
187        @echo "Testing of doctests in the sources finished, look at the " \
188              "results in $(BUILDDIR)/doctest/output.txt."
Note: See TracBrowser for help on using the repository browser.