Merge lp:~brianaker/drizzle/update-doc-build into lp:drizzle

Proposed by Brian Aker
Status: Merged
Approved by: Brian Aker
Approved revision: 2612
Merged at revision: 2612
Proposed branch: lp:~brianaker/drizzle/update-doc-build
Merge into: lp:drizzle
Diff against target: 188 lines (+33/-65)
3 files modified
Makefile.am (+1/-0)
docs/include.am (+30/-65)
po/Makefile.in.in (+2/-0)
To merge this branch: bzr merge lp:~brianaker/drizzle/update-doc-build
Reviewer Review Type Date Requested Status
Drizzle Trunk Pending
Review via email: mp+141585@code.launchpad.net
To post a comment you must log in.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'Makefile.am'
2--- Makefile.am 2012-10-17 11:28:54 +0000
3+++ Makefile.am 2013-01-02 07:50:27 +0000
4@@ -201,6 +201,7 @@
5 -rm -f m4/ltsugar.m4
6 -rm -f m4/ltversion.m4
7 -rm -f m4/lt~obsolete.m4
8+ -rm -rf html
9
10 include config/lcov.am
11
12
13=== modified file 'docs/include.am'
14--- docs/include.am 2012-12-27 08:53:57 +0000
15+++ docs/include.am 2013-01-02 07:50:27 +0000
16@@ -21,30 +21,25 @@
17 # Makefile for Sphinx documentation
18 #
19
20-SPHINXOPTS = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION}
21+SPHINXOPTS = ${SPHINX_WARNINGS} -q
22 PAPER =
23-SPHINX_BUILDDIR = ${top_builddir}/docs
24+SPHINX_BUILDDIR = ${abs_top_builddir}/docs
25
26 # Internal variables.
27 PAPEROPT_a4 = -D latex_paper_size=a4
28 PAPEROPT_letter = -D latex_paper_size=letter
29-ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs
30+ALLSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINX_BUILDDIR)
31
32 .PHONY: clean-docs-check
33-
34 clean-docs-check:
35 -rm -rf docs/_build docs/doctrees man/.doctrees/
36
37-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest doxygen
38-
39-doxygen:
40- ${DOXYGEN} docs/Doxyfile
41-
42+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
43 if HAVE_SPHINX
44+
45 sphinx-help:
46 @echo "Please use \`make <target>' where <target> is one of"
47 @echo " html to make standalone HTML files"
48- @echo " dirhtml to make HTML files named index.html in directories"
49 @echo " singlehtml to make a single large HTML file"
50 @echo " pickle to make pickle files"
51 @echo " json to make JSON files"
52@@ -60,61 +55,41 @@
53 @echo " linkcheck to check all external links for integrity"
54 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
55
56-html-local:
57- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
58- @echo
59- @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
60-
61-dirhtml:
62- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
63- @echo
64- @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
65-
66-singlehtml:
67- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
68- @echo
69- @echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
70-
71-pickle:
72+doc_dirs:
73+ @$(mkdir_p) $(SPHINX_BUILDDIR)/_static
74+
75+install-html-local: html-local
76+ @rm -rf $(htmldir)/html
77+ @cp -r ${top_builddir}/html/ $(htmldir)
78+
79+html-local: docs/conf.py
80+ @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ${top_builddir}/html
81+
82+singlehtml: html-local
83+ @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
84+
85+pickle: docs/conf.py
86 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
87 @echo
88 @echo "Build finished; now you can process the pickle files."
89
90-json:
91+json: docs/conf.py
92 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
93 @echo
94 @echo "Build finished; now you can process the JSON files."
95
96-htmlhelp:
97+htmlhelp: docs/conf.py
98 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
99 @echo
100 @echo "Build finished; now you can run HTML Help Workshop with the" \
101 ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
102
103-qthelp:
104- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
105- @echo
106- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
107- ".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
108- @echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhcp"
109- @echo "To view the help file:"
110- @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhc"
111-
112-devhelp:
113- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
114- @echo
115- @echo "Build finished."
116- @echo "To view the help file:"
117- @echo "# mkdir -p $$HOME/.local/share/devhelp/Drizzle"
118- @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Drizzle"
119- @echo "# devhelp"
120-
121-epub:
122+epub: docs/conf.py
123 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
124 @echo
125 @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
126
127-latex:
128+latex: docs/conf.py
129 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
130 @echo
131 @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
132@@ -127,17 +102,12 @@
133 make -C $(SPHINX_BUILDDIR)/latex all-pdf
134 @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
135
136-text:
137- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
138- @echo
139- @echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
140+text: docs/conf.py
141+ @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
142
143 if HAVE_RECENT_SPHINX
144-
145 man:
146- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) ${top_builddir}/man
147- @echo
148- @echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man."
149+ @PYTHONPATH=$(SPHINX_BUILDDIR)/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) ${top_builddir}/man
150
151 else
152
153@@ -145,18 +115,13 @@
154
155 endif
156
157-changes:
158- PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
159- @echo
160- @echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
161+changes: docs/conf.py
162+ @PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
163
164-linkcheck:
165+linkcheck: docs/conf.py
166 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
167- @echo
168- @echo "Link check complete; look for any errors in the above output " \
169- "or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
170
171-doctest:
172+doctest: docs/conf.py
173 PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
174 @echo "Testing of doctests in the sources finished, look at the " \
175 "results in $(SPHINX_BUILDDIR)/doctest/output.txt."
176
177=== modified file 'po/Makefile.in.in'
178--- po/Makefile.in.in 2012-10-17 10:40:21 +0000
179+++ po/Makefile.in.in 2013-01-02 07:50:27 +0000
180@@ -215,6 +215,8 @@
181 # We need one of these so we don't break if the html rule is used.
182 html:
183
184+install-html:
185+
186 # Tell versions [3.59,3.63) of GNU make not to export all variables.
187 # Otherwise a system limit (for SysV at least) may be exceeded.
188 .NOEXPORT:

Subscribers

People subscribed via source and target branches

to all changes: