doc/models/Makefile
author Nicola Baldo <nbaldo@cttc.es>
Fri, 11 May 2012 16:42:40 +0200
changeset 8749 4462ac63d4cf
parent 7878 715b1f392880
parent 8734 403c6e61d201
child 8751 efad81f3cb47
permissions -rw-r--r--
merge of the code from the LENA project into ns-3-dev
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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/emulation-overview.rst \
7845
ee22002d14b6 integrated antenna docs in models library docs
Nicola Baldo <nbaldo@cttc.es>
parents: 7665
diff changeset
    20
	$(SRC)/antenna/doc/source/antenna.rst \
ee22002d14b6 integrated antenna docs in models library docs
Nicola Baldo <nbaldo@cttc.es>
parents: 7665
diff changeset
    21
	$(SRC)/antenna/doc/source/antenna-design.rst \
ee22002d14b6 integrated antenna docs in models library docs
Nicola Baldo <nbaldo@cttc.es>
parents: 7665
diff changeset
    22
	$(SRC)/antenna/doc/source/antenna-user.rst \
ee22002d14b6 integrated antenna docs in models library docs
Nicola Baldo <nbaldo@cttc.es>
parents: 7665
diff changeset
    23
	$(SRC)/antenna/doc/source/antenna-testing.rst \
7266
bc99ae52b396 Move aodv module description out of doxygen
Tom Henderson <tomh@tomh.org>
parents: 7265
diff changeset
    24
	$(SRC)/aodv/doc/aodv.rst \
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    25
	$(SRC)/applications/doc/applications.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    26
	$(SRC)/bridge/doc/bridge.rst \
8260
c3bf1b481daf buildings doc can now be built standalone and within models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8171
diff changeset
    27
	$(SRC)/buildings/doc/source/buildings.rst \
c3bf1b481daf buildings doc can now be built standalone and within models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8171
diff changeset
    28
	$(SRC)/buildings/doc/source/buildings-design.rst \
c3bf1b481daf buildings doc can now be built standalone and within models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8171
diff changeset
    29
	$(SRC)/buildings/doc/source/buildings-user.rst \
c3bf1b481daf buildings doc can now be built standalone and within models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8171
diff changeset
    30
	$(SRC)/buildings/doc/source/buildings-testing.rst \
8734
403c6e61d201 decouple most propagation models from buildings module
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    31
	$(SRC)/buildings/doc/source/buildings-references.rst \
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    32
	$(SRC)/click/doc/click.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    33
	$(SRC)/csma/doc/csma.rst \
7265
e74cc5da55e8 Move dsdv module description out of doxygen
Mitch Watrous <watrous@u.washington.edu>
parents: 7204
diff changeset
    34
	$(SRC)/dsdv/doc/dsdv.rst \
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    35
	$(SRC)/mpi/doc/distributed.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    36
	$(SRC)/energy/doc/energy.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    37
	$(SRC)/emu/doc/emu.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    38
	$(SRC)/tap-bridge/doc/tap.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    39
	$(SRC)/mesh/doc/mesh.rst \
8100
8463ff56f14f moved lte doc sources & figures to subdirectorires
Nicola Baldo <nbaldo@cttc.es>
parents: 8098
diff changeset
    40
	$(SRC)/lte/doc/source/lte.rst \
8463ff56f14f moved lte doc sources & figures to subdirectorires
Nicola Baldo <nbaldo@cttc.es>
parents: 8098
diff changeset
    41
	$(SRC)/lte/doc/source/lte-user.rst \
8463ff56f14f moved lte doc sources & figures to subdirectorires
Nicola Baldo <nbaldo@cttc.es>
parents: 8098
diff changeset
    42
	$(SRC)/lte/doc/source/lte-design.rst \
8463ff56f14f moved lte doc sources & figures to subdirectorires
Nicola Baldo <nbaldo@cttc.es>
parents: 8098
diff changeset
    43
	$(SRC)/lte/doc/source/lte-testing.rst \
8323
3ae17689445d separate doc section for LTE module profiling
Nicola Baldo <nbaldo@cttc.es>
parents: 8307
diff changeset
    44
	$(SRC)/lte/doc/source/lte-profiling.rst \
8145
5b90e72e7f99 support for eps source images in models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
    45
	$(SRC)/lte/doc/source/lte-references.rst \
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    46
	$(SRC)/propagation/doc/propagation.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    47
	$(SRC)/network/doc/network-overview.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    48
	$(SRC)/network/doc/packets.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    49
	$(SRC)/network/doc/sockets-api.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    50
	$(SRC)/network/doc/simple.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    51
	$(SRC)/internet/doc/internet-stack.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    52
	$(SRC)/internet/doc/ipv4.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    53
	$(SRC)/internet/doc/ipv6.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    54
	$(SRC)/internet/doc/routing-overview.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    55
	$(SRC)/internet/doc/tcp.rst \
7878
715b1f392880 start some mobility documentation
Tom Henderson <tomh@tomh.org>
parents: 7845
diff changeset
    56
	$(SRC)/mobility/doc/mobility.rst \
7276
c360ed25ae69 Move uan module description out of doxygen
Tom Henderson <tomh@tomh.org>
parents: 7273
diff changeset
    57
	$(SRC)/olsr/doc/olsr.rst \
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    58
	$(SRC)/openflow/doc/openflow-switch.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    59
	$(SRC)/point-to-point/doc/point-to-point.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    60
	$(SRC)/wifi/doc/wifi.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    61
	$(SRC)/wimax/doc/wimax.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    62
	$(SRC)/uan/doc/uan.rst \
7665
a9d19a94df20 clear warnings in model library build process
Tom Henderson <tomh@tomh.org>
parents: 7325
diff changeset
    63
	$(SRC)/topology-read/doc/topology.rst \
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    64
	$(SRC)/stats/doc/statistics.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    65
	$(SRC)/netanim/doc/animation.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    66
	$(SRC)/flow-monitor/doc/flow-monitor.rst \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    67
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    68
# list all model library figure files that need to be copied to 
7325
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
    69
# $SOURCETEMP/figures.  For each figure to be included in all
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
    70
# documentation formats (html, latex...) the following formats are supported: 
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
    71
#  1) a single .dia file (preferred option, because it can be edited)
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
    72
#  2) a single .eps file
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
    73
#  3) both a .pdf and .png file
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    74
SOURCEFIGS = \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    75
	figures/testbed.dia \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    76
	figures/emulated-channel.dia \
7845
ee22002d14b6 integrated antenna docs in models library docs
Nicola Baldo <nbaldo@cttc.es>
parents: 7665
diff changeset
    77
	$(SRC)/antenna/doc/source/figures/antenna-coordinate-system.dia	\
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    78
	$(SRC)/network/doc/packet.dia \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    79
	$(SRC)/network/doc/node.dia \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    80
	$(SRC)/network/doc/buffer.dia \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    81
	$(SRC)/network/doc/sockets-overview.dia \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    82
	$(SRC)/internet/doc/internet-node-send.dia \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    83
	$(SRC)/internet/doc/internet-node-recv.dia \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    84
	$(SRC)/internet/doc/routing.dia \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    85
	$(SRC)/internet/doc/routing-specialization.dia \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    86
	$(SRC)/wifi/doc/WifiArchitecture.dia \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    87
	$(SRC)/wifi/doc/snir.dia \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    88
	$(SRC)/wimax/doc/WimaxArchitecture.dia \
8100
8463ff56f14f moved lte doc sources & figures to subdirectorires
Nicola Baldo <nbaldo@cttc.es>
parents: 8098
diff changeset
    89
	$(SRC)/lte/doc/source/figures/ff-mac-saps.dia \
8463ff56f14f moved lte doc sources & figures to subdirectorires
Nicola Baldo <nbaldo@cttc.es>
parents: 8098
diff changeset
    90
	$(SRC)/lte/doc/source/figures/ff-example.dia \
8463ff56f14f moved lte doc sources & figures to subdirectorires
Nicola Baldo <nbaldo@cttc.es>
parents: 8098
diff changeset
    91
	$(SRC)/lte/doc/source/figures/lte-enb-architecture.dia \
8463ff56f14f moved lte doc sources & figures to subdirectorires
Nicola Baldo <nbaldo@cttc.es>
parents: 8098
diff changeset
    92
	$(SRC)/lte/doc/source/figures/lte-ue-architecture.dia \
8483
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
    93
	$(SRC)/lte/doc/source/figures/epc-profiling-scenario.dia \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
    94
	$(SRC)/lte/doc/source/figures/eutran-profiling-scenario.dia \
8145
5b90e72e7f99 support for eps source images in models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
    95
	$(SRC)/lte/doc/source/figures/lte-interference-test-scenario.dia \
8483
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
    96
	$(SRC)/lte/doc/source/figures/epc-topology.dia \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
    97
	$(SRC)/lte/doc/source/figures/epc-data-flow-dl.dia \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
    98
	$(SRC)/lte/doc/source/figures/epc-data-flow-ul.dia \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
    99
	$(SRC)/lte/doc/source/figures/lte-arch-data-rrc-pdcp-rlc.dia \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   100
	$(SRC)/lte/doc/source/figures/lte-epc-e2e-data-protocol-stack.dia \
8683
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   101
	$(SRC)/lte/doc/source/figures/MCS_2_test.eps \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   102
	$(SRC)/lte/doc/source/figures/MCS_12_test.eps \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   103
	$(SRC)/lte/doc/source/figures/MCS_14_test.eps \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   104
	$(SRC)/lte/doc/source/figures/lena-dual-stripe.eps \
8145
5b90e72e7f99 support for eps source images in models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   105
	$(SRC)/lte/doc/source/figures/lte-mcs-index.eps \
5b90e72e7f99 support for eps source images in models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   106
	$(SRC)/lte/doc/source/figures/lenaThrTestCase1.eps \
5b90e72e7f99 support for eps source images in models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   107
	$(SRC)/lte/doc/source/figures/lenaThrTestCase2.eps \
8483
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   108
	$(SRC)/lte/doc/source/figures/runningTime10s.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   109
	$(SRC)/lte/doc/source/figures/epcRunningTime.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   110
	$(SRC)/lte/doc/source/figures/propagationModel.eps \
8145
5b90e72e7f99 support for eps source images in models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   111
	$(SRC)/lte/doc/source/figures/simulationTime.eps \
8483
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   112
	$(SRC)/lte/doc/source/figures/epcSimulationTime.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   113
	$(SRC)/lte/doc/source/figures/epcEutranRunningTime.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   114
	$(SRC)/lte/doc/source/figures/profiling-memory.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   115
	$(SRC)/lte/doc/source/figures/lte-rlc-implementation-model.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   116
	$(SRC)/lte/doc/source/figures/lte-rlc-data-txon-dl.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   117
	$(SRC)/lte/doc/source/figures/lte-rlc-data-retx-dl.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   118
	$(SRC)/lte/doc/source/figures/lte-rlc-data-txon-ul.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   119
	$(SRC)/lte/doc/source/figures/lte-rlc-data-retx-ul.eps \
8683
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   120
	$(SRC)/lte/doc/source/figures/fading_pedestrian.png \
8483
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   121
	$(SRC)/lte/doc/source/figures/fading_vehicular.png \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   122
	$(SRC)/lte/doc/source/figures/fading_urban_3kmph.png \
8683
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   123
	$(SRC)/lte/doc/source/figures/fading_pedestrian.pdf \
8298
0818f9a1d7d0 Update documentation with vehicular and urban traces
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8295
diff changeset
   124
	$(SRC)/lte/doc/source/figures/fading_vehicular.pdf \
0818f9a1d7d0 Update documentation with vehicular and urban traces
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8295
diff changeset
   125
	$(SRC)/lte/doc/source/figures/fading_urban_3kmph.pdf \
8683
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   126
	$(SRC)/lte/doc/source/figures/MCS_1_4.pdf \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   127
	$(SRC)/lte/doc/source/figures/MCS_1_4.png \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   128
	$(SRC)/lte/doc/source/figures/MCS_5_8.pdf \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   129
	$(SRC)/lte/doc/source/figures/MCS_5_8.png \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   130
	$(SRC)/lte/doc/source/figures/MCS_9_12.pdf \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   131
	$(SRC)/lte/doc/source/figures/MCS_9_12.png \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   132
	$(SRC)/lte/doc/source/figures/MCS_13_16.pdf \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   133
	$(SRC)/lte/doc/source/figures/MCS_13_16.png \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   134
	$(SRC)/lte/doc/source/figures/MCS_17_20.pdf \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   135
	$(SRC)/lte/doc/source/figures/MCS_17_20.png \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   136
	$(SRC)/lte/doc/source/figures/MCS_21_24.pdf \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   137
	$(SRC)/lte/doc/source/figures/MCS_21_24.png \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   138
	$(SRC)/lte/doc/source/figures/MCS_25_27.pdf \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   139
	$(SRC)/lte/doc/source/figures/MCS_25_27.png \
8483
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   140
	$(SRC)/lte/doc/source/figures/lte-phy-interference.png \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   141
	$(SRC)/lte/doc/source/figures/lte-phy-interference.pdf \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   142
	$(SRC)/lte/doc/source/figures/helpers.png \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   143
	$(SRC)/lte/doc/source/figures/helpers.pdf \
8683
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   144
	$(SRC)/lte/doc/source/figures/miesm_scheme.pdf \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   145
	$(SRC)/lte/doc/source/figures/miesm_scheme.png \
7306
611184f5148a Make statistical framework wiki be chapter in model library document
Mitch Watrous <watrous@u.washington.edu>
parents: 7276
diff changeset
   146
	$(SRC)/uan/doc/auvmobility-classes.dia \
611184f5148a Make statistical framework wiki be chapter in model library document
Mitch Watrous <watrous@u.washington.edu>
parents: 7276
diff changeset
   147
	$(SRC)/stats/doc/Stat-framework-arch.png \
611184f5148a Make statistical framework wiki be chapter in model library document
Mitch Watrous <watrous@u.washington.edu>
parents: 7276
diff changeset
   148
	$(SRC)/stats/doc/Wifi-default.png \
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   149
	$(SRC)/netanim/doc/animation-dumbbell.png \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   150
	$(SRC)/netanim/doc/animation-dumbbell.pdf \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   151
7325
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
   152
# specify figures from which .png and .pdf figures need to be
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
   153
# generated (all dia and eps figures)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   154
IMAGES_EPS = \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   155
	$(FIGURES)/testbed.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   156
	$(FIGURES)/emulated-channel.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   157
	$(FIGURES)/packet.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   158
	$(FIGURES)/node.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   159
	$(FIGURES)/buffer.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   160
	$(FIGURES)/sockets-overview.eps \
7845
ee22002d14b6 integrated antenna docs in models library docs
Nicola Baldo <nbaldo@cttc.es>
parents: 7665
diff changeset
   161
	$(FIGURES)/antenna-coordinate-system.eps \
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   162
	$(FIGURES)/internet-node-send.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   163
	$(FIGURES)/internet-node-recv.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   164
	$(FIGURES)/routing.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   165
	$(FIGURES)/routing-specialization.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   166
	$(FIGURES)/WifiArchitecture.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   167
	$(FIGURES)/snir.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   168
	$(FIGURES)/WimaxArchitecture.eps \
8098
575e7f7c6146 merge with ns-3-dev
Nicola Baldo <nbaldo@cttc.es>
parents: 7204
diff changeset
   169
	$(FIGURES)/ff-mac-saps.eps \
575e7f7c6146 merge with ns-3-dev
Nicola Baldo <nbaldo@cttc.es>
parents: 7204
diff changeset
   170
	$(FIGURES)/ff-example.eps \
575e7f7c6146 merge with ns-3-dev
Nicola Baldo <nbaldo@cttc.es>
parents: 7204
diff changeset
   171
	$(FIGURES)/lte-enb-architecture.eps \
575e7f7c6146 merge with ns-3-dev
Nicola Baldo <nbaldo@cttc.es>
parents: 7204
diff changeset
   172
	$(FIGURES)/lte-ue-architecture.eps \
8483
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   173
	$(FIGURES)/epc-profiling-scenario.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   174
	$(FIGURES)/eutran-profiling-scenario.eps \
8145
5b90e72e7f99 support for eps source images in models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   175
	$(FIGURES)/lte-interference-test-scenario.eps \
8483
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   176
	$(FIGURES)/epc-topology.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   177
	$(FIGURES)/epc-data-flow-dl.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   178
	$(FIGURES)/epc-data-flow-ul.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   179
	$(FIGURES)/lte-arch-data-rrc-pdcp-rlc.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   180
	$(FIGURES)/lte-epc-e2e-data-protocol-stack.eps \
8683
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   181
	$(FIGURES)/MCS_2_test.eps \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   182
	$(FIGURES)/MCS_12_test.eps \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   183
	$(FIGURES)/MCS_14_test.eps \
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8500
diff changeset
   184
	$(FIGURES)/lena-dual-stripe.eps \
8145
5b90e72e7f99 support for eps source images in models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   185
	$(FIGURES)/lte-mcs-index.eps \
5b90e72e7f99 support for eps source images in models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   186
	$(FIGURES)/lenaThrTestCase1.eps \
5b90e72e7f99 support for eps source images in models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   187
	$(FIGURES)/lenaThrTestCase2.eps \
8483
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   188
	$(FIGURES)/runningTime10s.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   189
	$(FIGURES)/epcRunningTime.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   190
	$(FIGURES)/propagationModel.eps \
8145
5b90e72e7f99 support for eps source images in models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   191
	$(FIGURES)/simulationTime.eps \
8483
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   192
	$(FIGURES)/epcSimulationTime.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   193
	$(FIGURES)/epcEutranRunningTime.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   194
	$(FIGURES)/profiling-memory.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   195
	$(FIGURES)/lte-rlc-implementation-model.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   196
	$(FIGURES)/lte-rlc-data-txon-dl.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   197
	$(FIGURES)/lte-rlc-data-retx-dl.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   198
	$(FIGURES)/lte-rlc-data-txon-ul.eps \
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   199
	$(FIGURES)/lte-rlc-data-retx-ul.eps \
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   200
        $(FIGURES)/auvmobility-classes.eps \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   201
7325
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
   202
# rescale pdf figures as necessary
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   203
$(FIGURES)/testbed.pdf_width = 5in
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   204
$(FIGURES)/emulated-channel.pdf_width = 6in
7845
ee22002d14b6 integrated antenna docs in models library docs
Nicola Baldo <nbaldo@cttc.es>
parents: 7665
diff changeset
   205
$(FIGURES)/antenna-coordinate-system.pdf_width = 7cm	
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   206
$(FIGURES)/node.pdf_width = 5in
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   207
$(FIGURES)/packet.pdf_width = 4in
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   208
$(FIGURES)/buffer.pdf_width = 15cm
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   209
$(FIGURES)/sockets-overview.pdf_width = 10cm
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   210
$(FIGURES)/internet-node-send.pdf_width = 5in
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   211
$(FIGURES)/internet-node-recv.pdf_width = 5in
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   212
$(FIGURES)/routing.pdf_width = 6in
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   213
$(FIGURES)/routing-specialization.pdf_width = 5in
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   214
$(FIGURES)/snir.pdf_width = 3in
8483
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   215
$(FIGURES)/lte-interference-test-scenario.pdf_width = 3in
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   216
$(FIGURES)/epc-topology.pdf_width = 4in
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   217
$(FIGURES)/lte-arch-data-rrc-pdcp-rlc.pdf_width = 3in
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   218
$(FIGURES)/lte-epc-e2e-data-protocol-stack.pdf_width = 15cm
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   219
$(FIGURES)/ff-mac-saps.pdf_width = 5in
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   220
$(FIGURES)/ff-example.pdf_width = 5in
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   221
$(FIGURES)/lte-rlc-implementation-model.pdf_width = 20in
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   222
$(FIGURES)/lte-rlc-data-txon-dl.pdf_width = 10cm
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   223
$(FIGURES)/lte-rlc-data-txon-ul.pdf_width = 10cm
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   224
$(FIGURES)/lte-rlc-data-retx-ul.pdf_width = 10cm
a21f6fd0976a fixed build of lte docs within models library
Nicola Baldo <nicola@baldo.biz>
parents: 8323
diff changeset
   225
$(FIGURES)/lte-phy-interference.pdf_width = 12cm
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   226
$(FIGURES)/auvmobility-classes.pdf_width = 10cm
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   227
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   228
IMAGES_PNG = ${IMAGES_EPS:.eps=.png}
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   229
IMAGES_PDF = ${IMAGES_EPS:.eps=.pdf}
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
IMAGES = $(IMAGES_EPS) $(IMAGES_PNG) $(IMAGES_PDF)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   232
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   233
%.eps : %.dia; $(DIA) -t eps $< -e $@
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   234
%.png : %.dia; $(DIA) -t png $< -e $@
7325
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
   235
%.png : %.eps; $(CONVERT) $< $@
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   236
%.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
   237
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   238
# You can set these variables from the command line.
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   239
SPHINXOPTS    =
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   240
SPHINXBUILD   = sphinx-build
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   241
PAPER         =
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   242
BUILDDIR      = build
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   243
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   244
# Internal variables.
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   245
PAPEROPT_a4     = -D latex_paper_size=a4
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   246
PAPEROPT_letter = -D latex_paper_size=letter
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   247
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCETEMP) 
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   248
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   249
.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
   250
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   251
help:
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   252
	@echo "Please use \`make <target>' where <target> is one of"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   253
	@echo "  html       to make standalone HTML files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   254
	@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
   255
	@echo "  singlehtml to make a single large HTML file"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   256
	@echo "  pickle     to make pickle files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   257
	@echo "  json       to make JSON files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   258
	@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
   259
	@echo "  qthelp     to make HTML files and a qthelp project"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   260
	@echo "  devhelp    to make HTML files and a Devhelp project"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   261
	@echo "  epub       to make an epub"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   262
	@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
   263
	@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
   264
	@echo "  text       to make text files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   265
	@echo "  man        to make manual pages"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   266
	@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
   267
	@echo "  linkcheck  to check all external links for integrity"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   268
	@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
   269
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   270
copy-sources:  $(SOURCES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   271
	@rm -rf $(SOURCETEMP)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   272
	@mkdir -p $(SOURCETEMP) 
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   273
	@mkdir -p $(FIGURES) 
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   274
	@cp -r $(SOURCES) $(SOURCETEMP)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   275
	@cp -r $(SOURCEFIGS) $(FIGURES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   276
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   277
clean:
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   278
	-rm -rf $(BUILDDIR)/*
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   279
	-rm -rf $(SOURCETEMP)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   280
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   281
frag: pickle
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   282
	@if test ! -d $(BUILDDIR)/frag; then mkdir $(BUILDDIR)/frag; fi
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   283
	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
   284
	cp -r $(BUILDDIR)/pickle/_images $(BUILDDIR)/frag
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   285
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   286
html: copy-sources $(IMAGES) 
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   287
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   288
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   289
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   290
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   291
dirhtml: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   292
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   293
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   294
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   295
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   296
singlehtml: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   297
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   298
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   299
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   300
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   301
pickle: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   302
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   303
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   304
	@echo "Build finished; now you can process the pickle files."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   305
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   306
json: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   307
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   308
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   309
	@echo "Build finished; now you can process the JSON files."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   310
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   311
htmlhelp: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   312
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   313
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   314
	@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
   315
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   316
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   317
qthelp: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   318
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   319
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   320
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   321
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   322
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ns-3.qhcp"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   323
	@echo "To view the help file:"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   324
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ns-3.qhc"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   325
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   326
devhelp: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   327
	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   328
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   329
	@echo "Build finished."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   330
	@echo "To view the help file:"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   331
	@echo "# mkdir -p $$HOME/.local/share/devhelp/ns-3"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   332
	@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
   333
	@echo "# devhelp"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   334
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   335
epub: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   336
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   337
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   338
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   339
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   340
latex: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   341
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   342
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   343
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   344
	@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
   345
	      "(use \`make latexpdf' here to do that automatically)."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   346
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   347
latexpdf: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   348
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   349
	@echo "Running LaTeX files through pdflatex..."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   350
	make -C $(BUILDDIR)/latex all-pdf
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   351
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   352
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   353
text: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   354
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   355
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   356
	@echo "Build finished. The text files are in $(BUILDDIR)/text."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   357
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   358
man: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   359
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   360
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   361
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   362
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   363
changes: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   364
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   365
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   366
	@echo "The overview file is in $(BUILDDIR)/changes."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   367
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   368
linkcheck: copy-sources $(IMAGEs)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   369
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   370
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   371
	@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
   372
	      "or in $(BUILDDIR)/linkcheck/output.txt."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   373
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   374
doctest: copy-sources $(IMAGES)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   375
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   376
	@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
   377
	      "results in $(BUILDDIR)/doctest/output.txt."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   378
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   379