source: NEMO/trunk/doc/rst/Makefile

Last change on this file was 11713, checked in by nicolasmartin, 14 months ago

Revamp TOP README and implement a TODO list
Review tracers.rst by adding snippets of source files
Add drafthtml target for Makefile related to draft building tag for sphinx-build to
display todo items at the top of the guide homepage

Misc:

  • Use dedicated :file: role instead of ... for file or directory
  • Update BibTeX entries of NEMO reference publications by using :title: role
  • Dump of RELEASE_NOTES.rst
  • New file todos.rst to list all items declared with todo directive
  • Modify conf.py to add a conditional test for draft tag
File size: 5.9 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 html dirhtml drafthtml 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 "  drafthtml  to make an autoupdate HTML export while editing (todo list included)"
24   @echo "  singlehtml to make a single large HTML file"
25   @echo "  pickle     to make pickle files"
26   @echo "  json       to make JSON files"
27   @echo "  htmlhelp   to make HTML files and a HTML help project"
28   @echo "  qthelp     to make HTML files and a qthelp project"
29   @echo "  devhelp    to make HTML files and a Devhelp project"
30   @echo "  epub       to make an epub"
31   @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
32   @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
33   @echo "  text       to make text files"
34   @echo "  man        to make manual pages"
35   @echo "  texinfo    to make Texinfo files"
36   @echo "  info       to make Texinfo files and run them through makeinfo"
37   @echo "  gettext    to make PO message catalogs"
38   @echo "  changes    to make an overview of all changed/added/deprecated items"
39   @echo "  linkcheck  to check all external links for integrity"
40   @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
41
42clean:
43   -rm -rf $(BUILDDIR)/*
44
45html:
46   $(SPHINXBUILD)   -b html          $(ALLSPHINXOPTS) $(BUILDDIR)/html
47   @echo
48   @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
49
50dirhtml:
51   $(SPHINXBUILD)   -b dirhtml       $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
52   @echo
53   @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
54
55drafthtml:
56   sphinx-autobuild -b html -t draft $(ALLSPHINXOPTS) $(BUILDDIR)/drafthtml
57   @echo
58   @echo "Build finished. The HTML pages are in $(BUILDDIR)/drafthtml."
59
60singlehtml:
61   $(SPHINXBUILD)   -b singlehtml    $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
62   @echo
63   @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
64
65pickle:
66   $(SPHINXBUILD)   -b pickle        $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
67   @echo
68   @echo "Build finished; now you can process the pickle files."
69
70json:
71   $(SPHINXBUILD)   -b json          $(ALLSPHINXOPTS) $(BUILDDIR)/json
72   @echo
73   @echo "Build finished; now you can process the JSON files."
74
75htmlhelp:
76   $(SPHINXBUILD)   -b htmlhelp      $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
77   @echo
78   @echo "Build finished; now you can run HTML Help Workshop with the" \
79         ".hhp project file in $(BUILDDIR)/htmlhelp."
80
81qthelp:
82   $(SPHINXBUILD)   -b qthelp        $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
83   @echo
84   @echo "Build finished; now you can run "qcollectiongenerator" with the" \
85         ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
86   @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NEMO.qhcp"
87   @echo "To view the help file:"
88   @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NEMO.qhc"
89
90devhelp:
91   $(SPHINXBUILD)   -b devhelp       $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
92   @echo
93   @echo "Build finished."
94   @echo "To view the help file:"
95   @echo "# mkdir -p $$HOME/.local/share/devhelp/NEMO"
96   @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NEMO"
97   @echo "# devhelp"
98
99epub:
100   $(SPHINXBUILD)   -b epub          $(ALLSPHINXOPTS) $(BUILDDIR)/epub
101   @echo
102   @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
103
104latex:
105   $(SPHINXBUILD)   -b latex         $(ALLSPHINXOPTS) $(BUILDDIR)/latex
106   @echo
107   @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
108   @echo "Run \`make' in that directory to run these through (pdf)latex" \
109         "(use \`make latexpdf' here to do that automatically)."
110
111latexpdf:
112   $(SPHINXBUILD)   -b latex         $(ALLSPHINXOPTS) $(BUILDDIR)/latex
113   @echo "Running LaTeX files through pdflatex..."
114   $(MAKE) -C $(BUILDDIR)/latex all-pdf
115   @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
116
117text:
118   $(SPHINXBUILD)   -b text          $(ALLSPHINXOPTS) $(BUILDDIR)/text
119   @echo
120   @echo "Build finished. The text files are in $(BUILDDIR)/text."
121
122man:
123   $(SPHINXBUILD)   -b man           $(ALLSPHINXOPTS) $(BUILDDIR)/man
124   @echo
125   @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
126
127texinfo:
128   $(SPHINXBUILD)   -b texinfo       $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
129   @echo
130   @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
131   @echo "Run \`make' in that directory to run these through makeinfo" \
132         "(use \`make info' here to do that automatically)."
133
134info:
135   $(SPHINXBUILD)   -b texinfo       $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
136   @echo "Running Texinfo files through makeinfo..."
137   make -C $(BUILDDIR)/texinfo info
138   @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
139
140gettext:
141   $(SPHINXBUILD)   -b gettext      $(I18NSPHINXOPTS) $(BUILDDIR)/locale
142   @echo
143   @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
144
145changes:
146   $(SPHINXBUILD)   -b changes       $(ALLSPHINXOPTS) $(BUILDDIR)/changes
147   @echo
148   @echo "The overview file is in $(BUILDDIR)/changes."
149
150linkcheck:
151   $(SPHINXBUILD)   -b linkcheck     $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
152   @echo
153   @echo "Link check complete; look for any errors in the above output " \
154         "or in $(BUILDDIR)/linkcheck/output.txt."
155
156doctest:
157   $(SPHINXBUILD)   -b doctest       $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
158   @echo "Testing of doctests in the sources finished, look at the " \
159         "results in $(BUILDDIR)/doctest/output.txt."
Note: See TracBrowser for help on using the repository browser.