-
Notifications
You must be signed in to change notification settings - Fork 2
/
Makefile
311 lines (266 loc) · 11.2 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
############################################################
## epydoc Makefile
##
## Edward Loper
############################################################
##//////////////////////////////////////////////////////////////////////
## Configuration variables
##//////////////////////////////////////////////////////////////////////
# Python source files (don't include src/epydoc/test?)
PY_SRC = src/epydoc/
PY_SRCFILES = $(shell find $(PY_SRC) -name '*.py')
EXAMPLES_SRC = $(wildcard doc/*.py)
DOCDIR = doc
DOCS = $(wildcard $(DOCDIR)/*)
DOCTESTS = $(wildcard src/epydoc/test/*.doctest)
MANUAL_SRC = $(wildcard doc/manual-*.txt)
# What version of python to use?
PYTHON = python2.5
export PYTHONPATH=src/
# The location of the webpage.
HOST = shell.sf.net
DIR = /home/groups/e/ep/epydoc/htdocs
# The current version of epydoc.
VERSION = $(shell $(PYTHON) -c 'import epydoc; print epydoc.__version__')
# Base output directories
WEBDIR = webpage
LATEX = latex
HTML = html
# Output subdirectories
HTML_MANUAL = $(HTML)
HTML_API = $(HTML)/api
HTML_EXAMPLES = $(HTML)/examples
HTML_STDLIB = $(HTML)/stdlib
HTML_DOCTEST = $(HTML)/doctest
LATEX_API = $(LATEX)/api.pdf
LATEX_STDLIB = $(LATEX)/stdlib.pdf
EPYDOC = $(PYTHON) src/epydoc/cli.py
RST2HTML = $(PYTHON) src/tools/rst2html.py
MKDISPATCH = $(PYTHON) src/tools/mkdispatch.py
STY2HTML = $(PYTHON) src/tools/sty2html.py
DOCTEST_HTML_FILES := \
$(DOCTESTS:src/epydoc/test/%.doctest=$(HTML_DOCTEST)/%.html)
MANUAL_HTML_FILES := $(HTML_MANUAL)/epydoc.html \
$(MANUAL_SRC:doc/manual-%.txt=$(HTML_MANUAL)/manual-%.html)
##//////////////////////////////////////////////////////////////////////
## Usage
##//////////////////////////////////////////////////////////////////////
.PHONY: all usage clean distributions web webpage xfer local
.PHONY: checkdocs api-html api-pdf examples stdlib-html stdlib-pdf
.PHONY: test tests
all: usage
usage:
@echo "Usage:"
@echo " make webpage -- build the webpage and copy it to sourceforge"
@echo " make api-html -- build the HTML docs for epydoc"
@echo " make api-pdf -- build the PDF docs for epydoc"
@echo " make doctest-html -- convert doctests to HTML"
@echo " make examples -- build example API docs for the webpage"
@echo " make stdlib-html -- build HTML docs for the Python Standard Library"
@echo " make checkdocs -- check the documentation completeness"
@echo " make distributions -- build the distributions"
@echo " make clean -- remove all built files"
@echo " make test -- run unit tests"
##//////////////////////////////////////////////////////////////////////
## Clean
##//////////////////////////////////////////////////////////////////////
clean:
$(MAKE) -C src clean
rm -rf $(WEBDIR) $(HTML) $(LATEX)
rm -rf .*.up2date
rm -rf profile.out
##//////////////////////////////////////////////////////////////////////
## Distributions
##//////////////////////////////////////////////////////////////////////
distributions: .distributions.up2date
.distributions.up2date: test $(PY_SRCFILES) .webpage.up2date $(DOCS)
$(MAKE) -C src distributions
touch .distributions.up2date
##//////////////////////////////////////////////////////////////////////
## Web page
##//////////////////////////////////////////////////////////////////////
web: xfer
webpage: xfer
xfer: test .webpage.up2date stdlib-html
rsync -arzv -e ssh $(WEBDIR)/* $(HOST):$(DIR)
rsync -arzv -e ssh $(HTML_STDLIB)/ $(HOST):$(DIR)/stdlib
local: .webpage.up2date
rm -rf /var/www/epydoc/*
cp -r $(WEBDIR)/* /var/www/epydoc
manual-html: $(MANUAL_HTML_FILES)
$(HTML_MANUAL)/epydoc.html: doc/manual.txt $(MANUAL_SRC) \
doc/epydoc-style-list.txt
$(RST2HTML) doc/manual.txt $@ --template=doc/rst-template.txt
$(HTML_MANUAL)/manual-%.html: doc/manual-%.txt doc/epydoc-style-list.txt
echo ".. include:: ../$<" > doc/tmp.txt
$(MKDISPATCH) $(MANUAL_SRC) >> doc/tmp.txt
$(RST2HTML) doc/tmp.txt $@ --template=doc/rst-template.txt
checkdoc: checkdocs
checkdocs:
epydoc --check --tests=vars,types $(PY_SRC)
.webpage.up2date: .api-html.up2date .examples.up2date .api-pdf.up2date \
$(DOCTEST_HTML_FILES) doc/epydoc-man.html \
doc/epydocgui-man.html $(DOCS) $(MANUAL_HTML_FILES)
rm -rf $(WEBDIR)
mkdir -p $(WEBDIR)
cp -r $(DOCS) $(WEBDIR)
cp -r $(HTML_MANUAL)/epydoc.html $(WEBDIR)
cp -r $(HTML_MANUAL)/manual*.html $(WEBDIR)
cp -r $(HTML_API) $(WEBDIR)/api
cp -r $(HTML_EXAMPLES) $(WEBDIR)/examples
cp -r $(HTML_DOCTEST)/* $(WEBDIR)/doctest
cp $(LATEX_API) $(WEBDIR)/epydoc.pdf
touch .webpage.up2date
# Use plaintext docformat by default. But this is overridden by the
# __docformat__ strings in each epydoc module. (So just
# xml.dom.minidom and a few Docutils modules get plaintext
# docstrings).
api-html: .api-html.up2date
.api-html.up2date: $(PY_SRCFILES) profile.out
rm -rf $(HTML_API)
mkdir -p $(HTML_API)
$(EPYDOC) -o $(HTML_API) --name epydoc --css white \
--url http://epydoc.sourceforge.net --pstat profile.out \
--inheritance=listed --navlink "epydoc $(VERSION)"\
--include-log \
--docformat plaintext -v --graph all --debug $(PY_SRC)
touch .api-html.up2date
api-pdf: .api-pdf.up2date
.api-pdf.up2date: $(PY_SRCFILES)
mkdir -p $(LATEX)
rm -f $(LATEX_API)
$(EPYDOC) --pdf -o $(LATEX_API) --docformat plaintext \
--no-submodule-list --graph classtree --sty shaded \
--name "Epydoc $(VERSION)" $(PY_SRC) -v --debug
touch .api-pdf.up2date
# Convert doctest files to HTML, using rst2html.
doctest-html: doctest-html-mkdir $(DOCTEST_HTML_FILES)
doctest-html-mkdir:
mkdir -p $(HTML_DOCTEST)
$(HTML_DOCTEST)/%.html: src/epydoc/test/%.doctest
mkdir -p $(HTML_DOCTEST)
$(RST2HTML) --stylesheet=../custom.css $< $@ \
--template=doc/rst-template2.txt
examples: .examples.up2date
.examples.up2date: $(EXAMPLES_SRC) $(PY_SRCFILES)
rm -rf $(HTML_EXAMPLES)
mkdir -p $(HTML_EXAMPLES)
$(EPYDOC) -o $(HTML_EXAMPLES) --name epydoc --debug \
--url http://epydoc.sourceforge.net \
--css white --top epytext_example --docformat=plaintext \
--navlink 'epydoc examples' doc/epytext_example.py sre
$(EPYDOC) -o $(HTML_EXAMPLES)/grouped --debug \
--inheritance=grouped \
--name epydoc --url http://epydoc.sourceforge.net \
--css white --debug \
--navlink 'epydoc examples' doc/inh_example.py
$(EPYDOC) -o $(HTML_EXAMPLES)/listed --debug \
--inheritance=listed \
--name epydoc --url http://epydoc.sourceforge.net \
--css white --debug \
--navlink 'epydoc examples' doc/inh_example.py
$(EPYDOC) -o $(HTML_EXAMPLES)/included --debug \
--inheritance=included \
--name epydoc --url http://epydoc.sourceforge.net \
--css white --debug \
--navlink 'epydoc examples' doc/inh_example.py
touch .examples.up2date
# Generate the HTML version of the man page. Note: The
# post-processing clean-up that I do is probably *not* very portable.
doc/epydoc-man.html: man/epydoc.1
man2html man/epydoc.1 \
| sed 's/<\/HEAD>/<link rel="stylesheet" href="epydoc.css" type="text\/css"\/><\/HEAD>/' \
| sed 's/<H1>EPYDOC<\/H1>/<H1>epydoc (1)<\/H1>/' \
| sed 's/<BODY>/<BODY><DIV CLASS="BODY">/'\
| sed 's/Content-type:.*//' \
| sed '/Section: User Commands/,/<HR>/{s/.*//;}'\
| sed 's/<\/BODY>/<\/DIV><\/BODY>/'\
| sed '/<DD>/{s/<DD>//; :loop; n; b loop;}'\
| sed 's/\(<A NAME=".*">\) <\/A>/\1/'\
| sed 's/<\/H2>/<\/H2><\/A>/'\
| sed 's/"\/cgi-bin\/man2html?epydocgui+1"/"epydocgui-man.html"/'\
| sed 's/<A HREF="\/cgi-bin\/man2html">man2html<\/A>/man2html/'\
> doc/epydoc-man.html
doc/epydocgui-man.html: man/epydocgui.1
man2html man/epydocgui.1 \
| sed 's/<\/HEAD>/<link rel="stylesheet" href="epydoc.css" type="text\/css"\/><\/HEAD>/' \
| sed 's/<H1>EPYDOCGUI<\/H1>/<H1>epydocgui (1)<\/H1>/'\
| sed 's/<BODY>/<BODY><DIV CLASS="BODY">/'\
| sed 's/Content-type:.*//' \
| sed '/Section: User Commands/,/<HR>/{s/.*//;}'\
| sed 's/<\/BODY>/<\/DIV><\/BODY>/'\
| sed '/<DD>/{s/<DD>//; :loop; n; b loop;}'\
| sed 's/\(<A NAME=".*">\) <\/A>/\1/'\
| sed 's/<\/H2>/<\/H2><\/A>/'\
| sed 's/"\/cgi-bin\/man2html?epydocgui+1"/"epydocgui-man.html"/'\
| sed 's/<A HREF="\/cgi-bin\/man2html">man2html<\/A>/man2html/'\
> doc/epydocgui-man.html
profile.out: $(PY_SRCFILES)
rm -f profile.out
$(EPYDOC) -o profile.tmp --name epydoc --css white --debug \
--url http://epydoc.sourceforge.net --profile-epydoc \
--inheritance=listed --navlink "epydoc $(VERSION)"\
--include-log \
--docformat plaintext -v --graph all $(PY_SRC)
rm -rf profile.tmp hotshot.out
# Convert builtin latex style files to html
doc/epydoc-style-list.txt: src/epydoc/docwriter/latex_sty.py \
src/tools/sty2html.py
$(STY2HTML) $(DOCDIR)
##//////////////////////////////////////////////////////////////////////
## Standard Library docs
##//////////////////////////////////////////////////////////////////////
SLNAME = 'Python Standard Library'
SLURL = "http://www.python.org/doc/lib/lib.html"
SLFILES = $(shell find /usr/lib/$(PYTHON)/ -name '*.py' -o -name '*.so' \
|grep -v "/$(PYTHON)/config/" \
|grep -v "/$(PYTHON)/lib-old/" \
|grep -v "/$(PYTHON)/idlelib/" \
|grep -v "/$(PYTHON)/site-packages/" \
|grep -v "/$(PYTHON)/__phello__\.foo\.py" )
PY_PRINT_BUILTINS = "import sys; print ' '.join(sys.builtin_module_names)"
SLBUILTINS = $(shell $(PYTHON) -c $(PY_PRINT_BUILTINS))
export TZ='XXX00XXX;000/00,000/00' # So tzparse won't die.
stdlib-html: .stdlib-html.up2date
.stdlib-html.up2date: $(PY_SRCFILES)
rm -rf $(HTML_STDLIB)
mkdir -p $(HTML_STDLIB)
@echo "Building stdlib html docs..."
@$(EPYDOC) -o $(HTML_STDLIB) --css white --name $(SLNAME) \
--url $(SLURL) --debug --no-sourcecode --debug \
--include-log --show-imports $(SLBUILTINS) $(SLFILES)
touch .stdlib-html.up2date
# (this will typically cause latex to run out of resources)
stdlib-pdf: .stdlib-pdf.up2date
.stdlib-pdf.up2date: $(PY_SRCFILES)
mkdir -p $(LATEX)
rm -f $(LATEX_STDLIB)
$(EPYDOC) --pdf -o $(LATEX_STDLIB) --debug \
--no-private --name $(SLNAME) --docformat plaintext \
--debug --builtins $(SLFILES)
##//////////////////////////////////////////////////////////////////////
## Unit Testing
##//////////////////////////////////////////////////////////////////////
tests: test
test:
$(PYTHON) src/epydoc/test/__init__.py
##//////////////////////////////////////////////////////////////////////
## Other test targets
##//////////////////////////////////////////////////////////////////////
docutils: docutils-html docutils-pdf
docutils-html: .docutils-html.up2date
.docutils-html.up2date: $(PY_SRCFILES)
rm -rf $(HTML)/docutils
mkdir -p $(HTML)/docutils
$(EPYDOC) -o $(HTML)/docutils -n 'Docutils' --html --debug \
--docformat plaintext --ignore-param-mismatch \
--include-log /usr/lib/python2.3/site-packages/docutils
touch .docutils-html.up2date
docutils-pdf: .docutils-pdf.up2date
.docutils-pdf.up2date: $(PY_SRCFILES)
rm -rf $(LATEX)/docutils
mkdir -p $(LATEX)/docutils
$(EPYDOC) -o $(LATEX)/docutils -n 'Docutils' --pdf --debug \
--docformat plaintext --ignore-param-mismatch \
/usr/lib/python2.3/site-packages/docutils
touch .docutils-pdf.up2date