author | Mitch Watrous <watrous@u.washington.edu> |
Tue, 24 May 2011 18:47:02 -0700 | |
changeset 7265 | e74cc5da55e8 |
parent 7204 | 052d30ceb700 |
child 7266 | bc99ae52b396 |
permissions | -rw-r--r-- |
7204
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
1 |
EPSTOPDF = epstopdf |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
2 |
DIA = dia |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
3 |
CONVERT = convert |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
4 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
5 |
SRC = ../../src |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
6 |
# Temporary source directory, for build |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
7 |
SOURCETEMP = source-temp |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
8 |
FIGURES = $(SOURCETEMP)/figures |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
9 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
10 |
# list all model library .rst files that need to be copied to $SOURCETEMP |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
11 |
SOURCES = \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
12 |
source/conf.py \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
13 |
source/_static \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
14 |
source/index.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
15 |
source/replace.txt \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
16 |
source/organization.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
17 |
source/internet-models.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
18 |
source/network.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
19 |
source/devices.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
20 |
source/routing.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
21 |
source/emulation-overview.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
22 |
source/support.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
23 |
$(SRC)/applications/doc/applications.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
24 |
$(SRC)/bridge/doc/bridge.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
25 |
$(SRC)/click/doc/click.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
26 |
$(SRC)/csma/doc/csma.rst \ |
7265
e74cc5da55e8
Move dsdv module description out of doxygen
Mitch Watrous <watrous@u.washington.edu>
parents:
7204
diff
changeset
|
27 |
$(SRC)/dsdv/doc/dsdv.rst \ |
7204
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
28 |
$(SRC)/mpi/doc/distributed.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
29 |
$(SRC)/energy/doc/energy.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
30 |
$(SRC)/emu/doc/emu.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
31 |
$(SRC)/tap-bridge/doc/tap.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
32 |
$(SRC)/mesh/doc/mesh.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
33 |
$(SRC)/lte/doc/lte.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
34 |
$(SRC)/propagation/doc/propagation.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
35 |
$(SRC)/network/doc/network-overview.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
36 |
$(SRC)/network/doc/packets.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
37 |
$(SRC)/network/doc/sockets-api.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
38 |
$(SRC)/network/doc/simple.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
39 |
$(SRC)/internet/doc/internet-stack.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
40 |
$(SRC)/internet/doc/ipv4.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
41 |
$(SRC)/internet/doc/ipv6.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
42 |
$(SRC)/internet/doc/routing-overview.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
43 |
$(SRC)/internet/doc/tcp.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
44 |
$(SRC)/openflow/doc/openflow-switch.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
45 |
$(SRC)/point-to-point/doc/point-to-point.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
46 |
$(SRC)/wifi/doc/wifi.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
47 |
$(SRC)/wimax/doc/wimax.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
48 |
$(SRC)/uan/doc/uan.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
49 |
$(SRC)/stats/doc/statistics.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
50 |
$(SRC)/netanim/doc/animation.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
51 |
$(SRC)/flow-monitor/doc/flow-monitor.rst \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
52 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
53 |
# list all model library figure files that need to be copied to |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
54 |
# $SOURCETEMP/figures. Either a .dia or both a .pdf and .png |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
55 |
SOURCEFIGS = \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
56 |
figures/testbed.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
57 |
figures/emulated-channel.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
58 |
$(SRC)/network/doc/packet.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
59 |
$(SRC)/network/doc/node.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
60 |
$(SRC)/network/doc/buffer.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
61 |
$(SRC)/network/doc/sockets-overview.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
62 |
$(SRC)/internet/doc/internet-node-send.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
63 |
$(SRC)/internet/doc/internet-node-recv.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
64 |
$(SRC)/internet/doc/routing.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
65 |
$(SRC)/internet/doc/routing-specialization.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
66 |
$(SRC)/wifi/doc/WifiArchitecture.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
67 |
$(SRC)/wifi/doc/snir.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
68 |
$(SRC)/wimax/doc/WimaxArchitecture.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
69 |
$(SRC)/lte/doc/lte-transmission.png \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
70 |
$(SRC)/lte/doc/lte-transmission.pdf \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
71 |
$(SRC)/uan/doc/auvmobility-classes.dia \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
72 |
$(SRC)/netanim/doc/animation-dumbbell.png \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
73 |
$(SRC)/netanim/doc/animation-dumbbell.pdf \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
74 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
75 |
# specify figures for build process (all dia figures) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
76 |
IMAGES_EPS = \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
77 |
$(FIGURES)/testbed.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
78 |
$(FIGURES)/emulated-channel.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
79 |
$(FIGURES)/packet.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
80 |
$(FIGURES)/node.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
81 |
$(FIGURES)/buffer.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
82 |
$(FIGURES)/sockets-overview.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
83 |
$(FIGURES)/internet-node-send.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
84 |
$(FIGURES)/internet-node-recv.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
85 |
$(FIGURES)/routing.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
86 |
$(FIGURES)/routing-specialization.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
87 |
$(FIGURES)/WifiArchitecture.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
88 |
$(FIGURES)/snir.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
89 |
$(FIGURES)/WimaxArchitecture.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
90 |
$(FIGURES)/auvmobility-classes.eps \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
91 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
92 |
# rescale figures as necessary |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
93 |
$(FIGURES)/testbed.pdf_width = 5in |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
94 |
$(FIGURES)/emulated-channel.pdf_width = 6in |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
95 |
$(FIGURES)/node.pdf_width = 5in |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
96 |
$(FIGURES)/packet.pdf_width = 4in |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
97 |
$(FIGURES)/buffer.pdf_width = 15cm |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
98 |
$(FIGURES)/sockets-overview.pdf_width = 10cm |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
99 |
$(FIGURES)/internet-node-send.pdf_width = 5in |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
100 |
$(FIGURES)/internet-node-recv.pdf_width = 5in |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
101 |
$(FIGURES)/routing.pdf_width = 6in |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
102 |
$(FIGURES)/routing-specialization.pdf_width = 5in |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
103 |
$(FIGURES)/snir.pdf_width = 3in |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
104 |
$(FIGURES)/lte-transmission.pdf_width = 3in |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
105 |
$(FIGURES)/auvmobility-classes.pdf_width = 10cm |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
106 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
107 |
IMAGES_PNG = ${IMAGES_EPS:.eps=.png} |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
108 |
IMAGES_PDF = ${IMAGES_EPS:.eps=.pdf} |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
109 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
110 |
IMAGES = $(IMAGES_EPS) $(IMAGES_PNG) $(IMAGES_PDF) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
111 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
112 |
%.eps : %.dia; $(DIA) -t eps $< -e $@ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
113 |
%.png : %.dia; $(DIA) -t png $< -e $@ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
114 |
%.pdf : %.eps; $(EPSTOPDF) $< -o=$@; if test x$($@_width) != x; then TMPFILE=`mktemp`; ./rescale-pdf.sh $($@_width) $@ $${TMPFILE} && mv $${TMPFILE} $@; fi |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
115 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
116 |
# You can set these variables from the command line. |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
117 |
SPHINXOPTS = |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
118 |
SPHINXBUILD = sphinx-build |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
119 |
PAPER = |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
120 |
BUILDDIR = build |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
121 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
122 |
# Internal variables. |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
123 |
PAPEROPT_a4 = -D latex_paper_size=a4 |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
124 |
PAPEROPT_letter = -D latex_paper_size=letter |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
125 |
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCETEMP) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
126 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
127 |
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
128 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
129 |
help: |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
130 |
@echo "Please use \`make <target>' where <target> is one of" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
131 |
@echo " html to make standalone HTML files" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
132 |
@echo " dirhtml to make HTML files named index.html in directories" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
133 |
@echo " singlehtml to make a single large HTML file" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
134 |
@echo " pickle to make pickle files" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
135 |
@echo " json to make JSON files" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
136 |
@echo " htmlhelp to make HTML files and a HTML help project" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
137 |
@echo " qthelp to make HTML files and a qthelp project" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
138 |
@echo " devhelp to make HTML files and a Devhelp project" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
139 |
@echo " epub to make an epub" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
140 |
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
141 |
@echo " latexpdf to make LaTeX files and run them through pdflatex" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
142 |
@echo " text to make text files" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
143 |
@echo " man to make manual pages" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
144 |
@echo " changes to make an overview of all changed/added/deprecated items" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
145 |
@echo " linkcheck to check all external links for integrity" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
146 |
@echo " doctest to run all doctests embedded in the documentation (if enabled)" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
147 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
148 |
copy-sources: $(SOURCES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
149 |
@rm -rf $(SOURCETEMP) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
150 |
@mkdir -p $(SOURCETEMP) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
151 |
@mkdir -p $(FIGURES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
152 |
@cp -r $(SOURCES) $(SOURCETEMP) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
153 |
@cp -r $(SOURCEFIGS) $(FIGURES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
154 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
155 |
clean: |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
156 |
-rm -rf $(BUILDDIR)/* |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
157 |
-rm -rf $(SOURCETEMP) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
158 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
159 |
frag: pickle |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
160 |
@if test ! -d $(BUILDDIR)/frag; then mkdir $(BUILDDIR)/frag; fi |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
161 |
pushd $(BUILDDIR)/frag && ../../pickle-to-xml.py ../pickle/index.fpickle > navigation.xml && popd |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
162 |
cp -r $(BUILDDIR)/pickle/_images $(BUILDDIR)/frag |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
163 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
164 |
html: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
165 |
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
166 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
167 |
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
168 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
169 |
dirhtml: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
170 |
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
171 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
172 |
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
173 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
174 |
singlehtml: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
175 |
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
176 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
177 |
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
178 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
179 |
pickle: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
180 |
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
181 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
182 |
@echo "Build finished; now you can process the pickle files." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
183 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
184 |
json: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
185 |
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
186 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
187 |
@echo "Build finished; now you can process the JSON files." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
188 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
189 |
htmlhelp: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
190 |
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
191 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
192 |
@echo "Build finished; now you can run HTML Help Workshop with the" \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
193 |
".hhp project file in $(BUILDDIR)/htmlhelp." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
194 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
195 |
qthelp: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
196 |
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
197 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
198 |
@echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
199 |
".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
200 |
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ns-3.qhcp" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
201 |
@echo "To view the help file:" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
202 |
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ns-3.qhc" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
203 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
204 |
devhelp: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
205 |
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
206 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
207 |
@echo "Build finished." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
208 |
@echo "To view the help file:" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
209 |
@echo "# mkdir -p $$HOME/.local/share/devhelp/ns-3" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
210 |
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ns-3" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
211 |
@echo "# devhelp" |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
212 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
213 |
epub: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
214 |
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
215 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
216 |
@echo "Build finished. The epub file is in $(BUILDDIR)/epub." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
217 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
218 |
latex: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
219 |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
220 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
221 |
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
222 |
@echo "Run \`make' in that directory to run these through (pdf)latex" \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
223 |
"(use \`make latexpdf' here to do that automatically)." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
224 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
225 |
latexpdf: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
226 |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
227 |
@echo "Running LaTeX files through pdflatex..." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
228 |
make -C $(BUILDDIR)/latex all-pdf |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
229 |
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
230 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
231 |
text: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
232 |
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
233 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
234 |
@echo "Build finished. The text files are in $(BUILDDIR)/text." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
235 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
236 |
man: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
237 |
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
238 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
239 |
@echo "Build finished. The manual pages are in $(BUILDDIR)/man." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
240 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
241 |
changes: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
242 |
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
243 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
244 |
@echo "The overview file is in $(BUILDDIR)/changes." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
245 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
246 |
linkcheck: copy-sources $(IMAGEs) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
247 |
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
248 |
@echo |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
249 |
@echo "Link check complete; look for any errors in the above output " \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
250 |
"or in $(BUILDDIR)/linkcheck/output.txt." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
251 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
252 |
doctest: copy-sources $(IMAGES) |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
253 |
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
254 |
@echo "Testing of doctests in the sources finished, look at the " \ |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
255 |
"results in $(BUILDDIR)/doctest/output.txt." |
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
256 |
|
052d30ceb700
split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
257 |