← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/include.am

  • Committer: lbieber
  • Date: 2010-09-12 00:01:32 UTC
  • mfrom: (1758.1.1 build)
  • Revision ID: lbieber@orisndriz03-20100912000132-o1y0z89inz44hg3j
Merge Monty - Adds initial skeleton for sphinx-based documentation. Will eventually hold man pages, developer docs and long-form documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/include.am
 
1
# vim:ft=automake
 
2
# included from Top Level Makefile.am
 
3
# All paths should be given relative to the root
 
4
 
 
5
EXTRA_DIST+= \
 
6
             docs/_static \
 
7
             docs/_templates \
 
8
             docs/conf.py \
 
9
             docs/index.rst
 
10
 
 
11
# Makefile for Sphinx documentation
 
12
#
 
13
 
 
14
SPHINXOPTS    =
 
15
PAPER         =
 
16
SPHINX_BUILDDIR      = ${top_builddir}/docs
 
17
 
 
18
# Internal variables.
 
19
PAPEROPT_a4     = -D latex_paper_size=a4
 
20
PAPEROPT_letter = -D latex_paper_size=letter
 
21
ALLSPHINXOPTS   = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs
 
22
 
 
23
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 
24
 
 
25
if HAVE_SPHINX
 
26
sphinx-help:
 
27
        @echo "Please use \`make <target>' where <target> is one of"
 
28
        @echo "  html       to make standalone HTML files"
 
29
        @echo "  dirhtml    to make HTML files named index.html in directories"
 
30
        @echo "  singlehtml to make a single large HTML file"
 
31
        @echo "  pickle     to make pickle files"
 
32
        @echo "  json       to make JSON files"
 
33
        @echo "  htmlhelp   to make HTML files and a HTML help project"
 
34
        @echo "  qthelp     to make HTML files and a qthelp project"
 
35
        @echo "  devhelp    to make HTML files and a Devhelp project"
 
36
        @echo "  epub       to make an epub"
 
37
        @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 
38
        @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 
39
        @echo "  text       to make text files"
 
40
        @echo "  man        to make manual pages"
 
41
        @echo "  changes    to make an overview of all changed/added/deprecated items"
 
42
        @echo "  linkcheck  to check all external links for integrity"
 
43
        @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 
44
 
 
45
html-local:
 
46
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
 
47
        @echo
 
48
        @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
 
49
 
 
50
dirhtml:
 
51
        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
 
52
        @echo
 
53
        @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
 
54
 
 
55
singlehtml:
 
56
        $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
 
57
        @echo
 
58
        @echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
 
59
 
 
60
pickle:
 
61
        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
 
62
        @echo
 
63
        @echo "Build finished; now you can process the pickle files."
 
64
 
 
65
json:
 
66
        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
 
67
        @echo
 
68
        @echo "Build finished; now you can process the JSON files."
 
69
 
 
70
htmlhelp:
 
71
        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
 
72
        @echo
 
73
        @echo "Build finished; now you can run HTML Help Workshop with the" \
 
74
              ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
 
75
 
 
76
qthelp:
 
77
        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
 
78
        @echo
 
79
        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
 
80
              ".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
 
81
        @echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhcp"
 
82
        @echo "To view the help file:"
 
83
        @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhc"
 
84
 
 
85
devhelp:
 
86
        $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
 
87
        @echo
 
88
        @echo "Build finished."
 
89
        @echo "To view the help file:"
 
90
        @echo "# mkdir -p $$HOME/.local/share/devhelp/Drizzle"
 
91
        @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Drizzle"
 
92
        @echo "# devhelp"
 
93
 
 
94
epub:
 
95
        $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
 
96
        @echo
 
97
        @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
 
98
 
 
99
latex:
 
100
        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
 
101
        @echo
 
102
        @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
 
103
        @echo "Run \`make' in that directory to run these through (pdf)latex" \
 
104
              "(use \`make latexpdf' here to do that automatically)."
 
105
 
 
106
latexpdf: latex
 
107
        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
 
108
        @echo "Running LaTeX files through pdflatex..."
 
109
        make -C $(SPHINX_BUILDDIR)/latex all-pdf
 
110
        @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
 
111
 
 
112
text:
 
113
        $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
 
114
        @echo
 
115
        @echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
 
116
 
 
117
man:
 
118
        $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man
 
119
        @echo
 
120
        @echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man."
 
121
 
 
122
changes:
 
123
        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
 
124
        @echo
 
125
        @echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
 
126
 
 
127
linkcheck:
 
128
        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
 
129
        @echo
 
130
        @echo "Link check complete; look for any errors in the above output " \
 
131
              "or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
 
132
 
 
133
doctest:
 
134
        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
 
135
        @echo "Testing of doctests in the sources finished, look at the " \
 
136
              "results in $(SPHINX_BUILDDIR)/doctest/output.txt."
 
137
endif