src/lte/doc/Makefile
author Manuel Requena <manuel.requena@cttc.es>
Fri, 19 Apr 2013 17:51:58 +0200
changeset 10045 26a4c08df793
parent 9517 143523a0aba8
child 10097 b7d9a6de6e94
child 10243 9469216ea5a6
permissions -rw-r--r--
Add automatic handover documentation
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
8453
001bb412e575 rescaled figures in LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8439
diff changeset
     3
SEQDIAG = seqdiag
9516
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
     4
DOT = dot
8439
2898be1813f9 Profiling plots and results ready for M4 delivery
Jaume Nin
parents: 8434
diff changeset
     5
CONVERT = convert -density 250
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     6
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     7
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
     8
SOURCE = source
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
     9
FIGURES = $(SOURCE)/figures
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    10
8703
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    11
# specify dia figures from which .png and .pdf figures need to be built
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    12
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    13
IMAGES_DIA = \
9517
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    14
        $(FIGURES)/epc-ctrl-arch.dia \
8703
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    15
	$(FIGURES)/epc-data-flow-dl.dia \
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    16
	$(FIGURES)/epc-data-flow-ul.dia \
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    17
	$(FIGURES)/epc-profiling-scenario.dia \
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    18
	$(FIGURES)/epc-topology.dia \
9311
1a2fbd32ca71 Add files to the build system for x2 design document
Manuel Requena <manuel.requena@cttc.es>
parents: 8703
diff changeset
    19
	$(FIGURES)/epc-topology-x2-enhanced.dia \
8703
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    20
	$(FIGURES)/eutran-profiling-scenario.dia \
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    21
	$(FIGURES)/ff-example.dia \
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    22
	$(FIGURES)/ff-mac-saps.dia \
9517
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    23
	$(FIGURES)/lte-arch-enb-data.dia \
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    24
	$(FIGURES)/lte-arch-enb-ctrl.dia \
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    25
	$(FIGURES)/lte-arch-ue-data.dia \
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    26
	$(FIGURES)/lte-arch-ue-ctrl.dia \
9335
ed490cfe9ec0 updated docs with revised LTE radio protocol stack architecture
Nicola Baldo <nbaldo@cttc.es>
parents: 9319
diff changeset
    27
	$(FIGURES)/lte-enb-phy.dia \
ed490cfe9ec0 updated docs with revised LTE radio protocol stack architecture
Nicola Baldo <nbaldo@cttc.es>
parents: 9319
diff changeset
    28
	$(FIGURES)/lte-ue-phy.dia \
8703
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    29
	$(FIGURES)/lte-epc-e2e-data-protocol-stack.dia \
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    30
	$(FIGURES)/lte-interference-test-scenario.dia \
9346
00e674a0d567 merge lena-dev and lena-epc
Nicola Baldo <nbaldo@cttc.es>
parents: 9336 9047
diff changeset
    31
	$(FIGURES)/lte-subframe-structure.dia \
9348
93dc6b96a53a HARQ design documentation 1st draft
Marco Miozzo <marco.miozzo@cttc.es>
parents: 9346
diff changeset
    32
	$(FIGURES)/lte-epc-x2-interface.dia \
93dc6b96a53a HARQ design documentation 1st draft
Marco Miozzo <marco.miozzo@cttc.es>
parents: 9346
diff changeset
    33
	$(FIGURES)/lte-harq-architecture.dia \
93dc6b96a53a HARQ design documentation 1st draft
Marco Miozzo <marco.miozzo@cttc.es>
parents: 9346
diff changeset
    34
	$(FIGURES)/lte-harq-processes-scheme.dia
8703
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    35
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    36
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    37
# specify eps figures from which .png and .pdf figures need to be built
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    38
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    39
IMAGES_EPS = \
8683
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8658
diff changeset
    40
	$(FIGURES)/lena-dual-stripe.eps \
8123
1845b08b90a5 updated testing doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8118
diff changeset
    41
	$(FIGURES)/lte-mcs-index.eps \
1845b08b90a5 updated testing doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8118
diff changeset
    42
	$(FIGURES)/lenaThrTestCase1.eps \
8125
42d1b1f274d9 updated perf doc; allinone pdf doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8123
diff changeset
    43
	$(FIGURES)/lenaThrTestCase2.eps \
8336
6d9e4efa1105 First draft of the profiling results. Validation and second reading pending
Jaume Nin
parents: 8305
diff changeset
    44
	$(FIGURES)/runningTime10s.eps \
8439
2898be1813f9 Profiling plots and results ready for M4 delivery
Jaume Nin
parents: 8434
diff changeset
    45
	$(FIGURES)/epcRunningTime.eps \
8336
6d9e4efa1105 First draft of the profiling results. Validation and second reading pending
Jaume Nin
parents: 8305
diff changeset
    46
	$(FIGURES)/propagationModel.eps \
8337
87cadbed554b Add figure with memory profiling
Manuel Requena <manuel.requena@cttc.es>
parents: 8336
diff changeset
    47
	$(FIGURES)/simulationTime.eps \
8439
2898be1813f9 Profiling plots and results ready for M4 delivery
Jaume Nin
parents: 8434
diff changeset
    48
	$(FIGURES)/epcSimulationTime.eps \
2898be1813f9 Profiling plots and results ready for M4 delivery
Jaume Nin
parents: 8434
diff changeset
    49
	$(FIGURES)/epcEutranRunningTime.eps \
8400
b1982cf326e4 fixed Makefile
Nicola Baldo <nbaldo@cttc.es>
parents: 8399
diff changeset
    50
	$(FIGURES)/profiling-memory.eps \
8388
a1879ae087c9 Add RLC design documentation
Manuel Requena <manuel.requena@cttc.es>
parents: 8171
diff changeset
    51
	$(FIGURES)/lte-rlc-implementation-model.eps \
a1879ae087c9 Add RLC design documentation
Manuel Requena <manuel.requena@cttc.es>
parents: 8171
diff changeset
    52
	$(FIGURES)/lte-rlc-data-txon-dl.eps \
a1879ae087c9 Add RLC design documentation
Manuel Requena <manuel.requena@cttc.es>
parents: 8171
diff changeset
    53
	$(FIGURES)/lte-rlc-data-retx-dl.eps \
a1879ae087c9 Add RLC design documentation
Manuel Requena <manuel.requena@cttc.es>
parents: 8171
diff changeset
    54
	$(FIGURES)/lte-rlc-data-txon-ul.eps \
9311
1a2fbd32ca71 Add files to the build system for x2 design document
Manuel Requena <manuel.requena@cttc.es>
parents: 8703
diff changeset
    55
	$(FIGURES)/lte-rlc-data-retx-ul.eps \
1a2fbd32ca71 Add files to the build system for x2 design document
Manuel Requena <manuel.requena@cttc.es>
parents: 8703
diff changeset
    56
	$(FIGURES)/lte-epc-x2-handover-seq-diagram.eps \
1a2fbd32ca71 Add files to the build system for x2 design document
Manuel Requena <manuel.requena@cttc.es>
parents: 8703
diff changeset
    57
	$(FIGURES)/lte-epc-x2-entity-saps.eps
8427
a593be5b26d0 added figures for M4 design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8411
diff changeset
    58
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    59
7325
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
    60
# rescale pdf figures as necessary
8453
001bb412e575 rescaled figures in LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8439
diff changeset
    61
$(FIGURES)/lte-interference-test-scenario.pdf_width = 3in
9517
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    62
$(FIGURES)/epc-ctrl-arch.pdf_width = 8cm
8453
001bb412e575 rescaled figures in LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8439
diff changeset
    63
$(FIGURES)/epc-topology.pdf_width = 4in
9311
1a2fbd32ca71 Add files to the build system for x2 design document
Manuel Requena <manuel.requena@cttc.es>
parents: 8703
diff changeset
    64
$(FIGURES)/epc-topology-x2-enhanced.pdf_width = 14cm
8453
001bb412e575 rescaled figures in LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8439
diff changeset
    65
$(FIGURES)/lte-arch-data-rrc-pdcp-rlc.pdf_width = 3in
001bb412e575 rescaled figures in LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8439
diff changeset
    66
$(FIGURES)/lte-epc-e2e-data-protocol-stack.pdf_width = 15cm
8473
5c4080fe9a9d review RLC testing and some typos in doc
Manuel Requena <manuel.requena@cttc.es>
parents: 8469
diff changeset
    67
$(FIGURES)/ff-mac-saps.pdf_width = 5in
5c4080fe9a9d review RLC testing and some typos in doc
Manuel Requena <manuel.requena@cttc.es>
parents: 8469
diff changeset
    68
$(FIGURES)/ff-example.pdf_width = 5in
9517
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    69
$(FIGURES)/lte-arch-enb-data.pdf_width = 6cm 
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    70
$(FIGURES)/lte-arch-enb-ctrl.pdf_width = 10cm
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    71
$(FIGURES)/lte-arch-ue-data.pdf_width = 6cm
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    72
$(FIGURES)/lte-arch-ue-ctrl.pdf_width = 10cm
8473
5c4080fe9a9d review RLC testing and some typos in doc
Manuel Requena <manuel.requena@cttc.es>
parents: 8469
diff changeset
    73
$(FIGURES)/lte-rlc-implementation-model.pdf_width = 20in
8453
001bb412e575 rescaled figures in LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8439
diff changeset
    74
$(FIGURES)/lte-rlc-data-txon-dl.pdf_width = 10cm
001bb412e575 rescaled figures in LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8439
diff changeset
    75
$(FIGURES)/lte-rlc-data-txon-ul.pdf_width = 10cm
001bb412e575 rescaled figures in LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8439
diff changeset
    76
$(FIGURES)/lte-rlc-data-retx-ul.pdf_width = 10cm
8469
341f1ced6273 fixed witdh of lte-phy-interference.pdf
Nicola Baldo <nbaldo@cttc.es>
parents: 8468
diff changeset
    77
$(FIGURES)/lte-phy-interference.pdf_width = 12cm
9045
9786bf474ea1 Update LENA documentation with Ctrl and Ref signaling part
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8794
diff changeset
    78
$(FIGURES)/lte-subframe-structure.pdf_width = 2in
9517
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    79
$(FIGURES)/mac-random-access-contention.pdf_width = 10cm
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    80
$(FIGURES)/mac-random-access-noncontention.pdf_width = 15cm
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    81
$(FIGURES)/lte-ue-rrc-states.pdf_width = 7cm
10045
26a4c08df793 Add automatic handover documentation
Manuel Requena <manuel.requena@cttc.es>
parents: 9517
diff changeset
    82
$(FIGURES)/lte-handover-algorithm.pdf_width = 10cm
9517
143523a0aba8 updated and reorganized LTE design docs
Nicola Baldo <nbaldo@cttc.es>
parents: 9516
diff changeset
    83
$(FIGURES)/helpers.pdf_width = 8cm
8340
4f3066644c06 Some profiling test refurbished, not final yet. Makefile fixed so it won't delete non autogenerated pdf and eps figures
Jaume Nin
parents: 8337
diff changeset
    84
8468
5d2648da7237 all seqdiag figures now generated within Makefile
Nicola Baldo <nbaldo@cttc.es>
parents: 8467
diff changeset
    85
IMAGES_SEQDIAG = \
8703
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
    86
	$(FIGURES)/lte-phy-interference.seqdiag \
9314
Nicola Baldo <nbaldo@cttc.es>
parents: 9313 8825
diff changeset
    87
	$(FIGURES)/helpers.seqdiag \
9516
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
    88
	$(FIGURES)/mac-random-access-contention.seqdiag \
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
    89
	$(FIGURES)/mac-random-access-noncontention.seqdiag \
9314
Nicola Baldo <nbaldo@cttc.es>
parents: 9313 8825
diff changeset
    90
	$(FIGURES)/rrc-connection-establishment.seqdiag \
Nicola Baldo <nbaldo@cttc.es>
parents: 9313 8825
diff changeset
    91
	$(FIGURES)/rrc-connection-reconfiguration.seqdiag \
Nicola Baldo <nbaldo@cttc.es>
parents: 9313 8825
diff changeset
    92
	$(FIGURES)/rrc-connection-reconfiguration-handover.seqdiag \
9516
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
    93
	$(FIGURES)/nas-attach.seqdiag 
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
    94
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
    95
IMAGES_DOT = \
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
    96
	$(FIGURES)/lte-enb-rrc-states.dot \
10045
26a4c08df793 Add automatic handover documentation
Manuel Requena <manuel.requena@cttc.es>
parents: 9517
diff changeset
    97
	$(FIGURES)/lte-ue-rrc-states.dot \
26a4c08df793 Add automatic handover documentation
Manuel Requena <manuel.requena@cttc.es>
parents: 9517
diff changeset
    98
	$(FIGURES)/lte-handover-algorithm.dot
8468
5d2648da7237 all seqdiag figures now generated within Makefile
Nicola Baldo <nbaldo@cttc.es>
parents: 8467
diff changeset
    99
8703
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   100
IMAGES_NOBUILD = $(FIGURES)/fading_pedestrian.png \
8305
1cead09f5e7e Add vehicular and urban figure in doc Makefile
mmiozzo
parents: 8171
diff changeset
   101
	$(FIGURES)/fading_vehicular.png \
8340
4f3066644c06 Some profiling test refurbished, not final yet. Makefile fixed so it won't delete non autogenerated pdf and eps figures
Jaume Nin
parents: 8337
diff changeset
   102
	$(FIGURES)/fading_urban_3kmph.png \
8305
1cead09f5e7e Add vehicular and urban figure in doc Makefile
mmiozzo
parents: 8171
diff changeset
   103
	$(FIGURES)/fading_pedestrian.pdf \
1cead09f5e7e Add vehicular and urban figure in doc Makefile
mmiozzo
parents: 8171
diff changeset
   104
	$(FIGURES)/fading_vehicular.pdf \
8532
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   105
	$(FIGURES)/fading_urban_3kmph.pdf \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   106
	$(FIGURES)/MCS_1_4.pdf \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   107
	$(FIGURES)/MCS_1_4.png \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   108
	$(FIGURES)/MCS_5_8.pdf \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   109
	$(FIGURES)/MCS_5_8.png \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   110
	$(FIGURES)/MCS_9_12.pdf \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   111
	$(FIGURES)/MCS_9_12.png \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   112
	$(FIGURES)/MCS_13_16.pdf \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   113
	$(FIGURES)/MCS_13_16.png \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   114
	$(FIGURES)/MCS_17_20.pdf \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   115
	$(FIGURES)/MCS_17_20.png \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   116
	$(FIGURES)/MCS_21_24.pdf \
fa4eceab8756 Update PEM doc with test section and annex with MCSs BLER figures
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8529
diff changeset
   117
	$(FIGURES)/MCS_21_24.png \
8794
a68aeda2d85b Update PEM model with new BLER curves based on standard ECR
mmiozzo
parents: 8749
diff changeset
   118
	$(FIGURES)/MCS_25_28.pdf \
8825
85fb8f3dc39d fixed bug 1437 - LTE documentation missing figures and references
Nicola Baldo <nbaldo@cttc.es>
parents: 8794
diff changeset
   119
	$(FIGURES)/MCS_25_28.png \
8794
a68aeda2d85b Update PEM model with new BLER curves based on standard ECR
mmiozzo
parents: 8749
diff changeset
   120
	$(FIGURES)/MCS_29_29.pdf \
a68aeda2d85b Update PEM model with new BLER curves based on standard ECR
mmiozzo
parents: 8749
diff changeset
   121
	$(FIGURES)/MCS_29_29.png \
a68aeda2d85b Update PEM model with new BLER curves based on standard ECR
mmiozzo
parents: 8749
diff changeset
   122
	$(FIGURES)/MCS_2_test.png \
a68aeda2d85b Update PEM model with new BLER curves based on standard ECR
mmiozzo
parents: 8749
diff changeset
   123
	$(FIGURES)/MCS_2_test.pdf \
a68aeda2d85b Update PEM model with new BLER curves based on standard ECR
mmiozzo
parents: 8749
diff changeset
   124
	$(FIGURES)/MCS_12_test.png \
a68aeda2d85b Update PEM model with new BLER curves based on standard ECR
mmiozzo
parents: 8749
diff changeset
   125
	$(FIGURES)/MCS_12_test.pdf \
a68aeda2d85b Update PEM model with new BLER curves based on standard ECR
mmiozzo
parents: 8749
diff changeset
   126
	$(FIGURES)/MCS_16_test.png \
a68aeda2d85b Update PEM model with new BLER curves based on standard ECR
mmiozzo
parents: 8749
diff changeset
   127
	$(FIGURES)/MCS_16_test.pdf \
8467
6aed03502f50 renamed lte phy interference figure
Nicola Baldo <nbaldo@cttc.es>
parents: 8453
diff changeset
   128
	$(FIGURES)/lte-phy-interference.png \
8468
5d2648da7237 all seqdiag figures now generated within Makefile
Nicola Baldo <nbaldo@cttc.es>
parents: 8467
diff changeset
   129
	$(FIGURES)/lte-phy-interference.pdf \
5d2648da7237 all seqdiag figures now generated within Makefile
Nicola Baldo <nbaldo@cttc.es>
parents: 8467
diff changeset
   130
	$(FIGURES)/helpers.png \
5d2648da7237 all seqdiag figures now generated within Makefile
Nicola Baldo <nbaldo@cttc.es>
parents: 8467
diff changeset
   131
	$(FIGURES)/helpers.pdf \
8546
52376a02184e Update MIESM Figure for having a good resolution in html
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8539
diff changeset
   132
	$(FIGURES)/miesm_scheme.pdf \
52376a02184e Update MIESM Figure for having a good resolution in html
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8539
diff changeset
   133
	$(FIGURES)/miesm_scheme.png \
8703
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   134
	${IMAGES_SEQDIAG:.seqdiag=.png} \
9516
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
   135
	${IMAGES_SEQDIAG:.seqdiag=.pdf} \
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
   136
	${IMAGES_DOT:.dot=.png} \
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
   137
	${IMAGES_DOT:.dot=.pdf} \
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
   138
8305
1cead09f5e7e Add vehicular and urban figure in doc Makefile
mmiozzo
parents: 8171
diff changeset
   139
8703
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   140
IMAGES_BUILD = \
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   141
	${IMAGES_DIA:.dia=.eps} \
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   142
	${IMAGES_DIA:.dia=.png} \
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   143
	${IMAGES_DIA:.dia=.pdf} \
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   144
	${IMAGES_EPS:.eps=.png} \
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   145
	${IMAGES_EPS:.eps=.pdf} 
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   146
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   147
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   148
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   149
IMAGES = $(IMAGES_NOBUILD) $(IMAGES_BUILD)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   150
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   151
%.eps : %.dia; $(DIA) -t eps $< -e $@
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   152
%.png : %.dia; $(DIA) -t png $< -e $@
9313
07407a88a061 draft design docs for RRC + NAS + MAC RA procedure
Nicola Baldo <nbaldo@cttc.es>
parents: 8658
diff changeset
   153
%.png : %.seqdiag; $(SEQDIAG) -Tpng --no-transparency -o $@ $< 
9516
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
   154
%.png : %.dot; $(DOT) -Tpng -o$@ $< 
7325
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
   155
%.png : %.eps; $(CONVERT) $< $@
8961
3b39221dd8d4 Remove temp files after building pdf docs
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 8825
diff changeset
   156
%.pdf : %.seqdiag
3b39221dd8d4 Remove temp files after building pdf docs
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 8825
diff changeset
   157
	$(SEQDIAG) -Tpdf -o $@ $<
3b39221dd8d4 Remove temp files after building pdf docs
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 8825
diff changeset
   158
	if test x$($@_width) != x; then ./rescale-pdf.sh $($@_width) $@ ; fi
9516
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
   159
%.pdf : %.dot
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
   160
	$(DOT) -Tpdf -o $@ $<
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
   161
	if test x$($@_width) != x; then ./rescale-pdf.sh $($@_width) $@ ; fi
8961
3b39221dd8d4 Remove temp files after building pdf docs
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 8825
diff changeset
   162
%.pdf : %.eps
3b39221dd8d4 Remove temp files after building pdf docs
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 8825
diff changeset
   163
	$(EPSTOPDF) $< -o=$@
3b39221dd8d4 Remove temp files after building pdf docs
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 8825
diff changeset
   164
	if test x$($@_width) != x; ./rescale-pdf.sh $($@_width) $@ ; fi
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   165
8118
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
   166
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
   167
%.png : %.eps; $(CONVERT) $< $@
8961
3b39221dd8d4 Remove temp files after building pdf docs
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 8825
diff changeset
   168
%.pdf : %.eps
3b39221dd8d4 Remove temp files after building pdf docs
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 8825
diff changeset
   169
	$(EPSTOPDF) $< -o=$@
3b39221dd8d4 Remove temp files after building pdf docs
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 8825
diff changeset
   170
	if test x$($@_width) != x; then ./rescale-pdf.sh $($@_width) $@ ; fi
8118
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
   171
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   172
# You can set these variables from the command line.
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   173
SPHINXOPTS    =
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   174
SPHINXBUILD   = sphinx-build
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   175
PAPER         =
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   176
BUILDDIR      = build
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   177
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   178
# Internal variables.
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   179
PAPEROPT_a4     = -D latex_paper_size=a4
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   180
PAPEROPT_letter = -D latex_paper_size=letter
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   181
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCE) 
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   182
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   183
.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
   184
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   185
help:
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   186
	@echo "Please use \`make <target>' where <target> is one of"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   187
	@echo "  html       to make standalone HTML files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   188
	@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
   189
	@echo "  singlehtml to make a single large HTML file"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   190
	@echo "  pickle     to make pickle files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   191
	@echo "  json       to make JSON files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   192
	@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
   193
	@echo "  qthelp     to make HTML files and a qthelp project"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   194
	@echo "  devhelp    to make HTML files and a Devhelp project"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   195
	@echo "  epub       to make an epub"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   196
	@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
   197
	@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
   198
	@echo "  text       to make text files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   199
	@echo "  man        to make manual pages"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   200
	@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
   201
	@echo "  linkcheck  to check all external links for integrity"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   202
	@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
   203
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   204
clean:
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   205
	-rm -rf $(BUILDDIR)/*
8703
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   206
	-rm -f $(IMAGES_BUILD)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   207
9516
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
   208
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
   209
images: $(IMAGES_NOBUILD) $(IMAGES_BUILD)
1291a9840b22 reorganized design doc
Nicola Baldo <nbaldo@cttc.es>
parents: 9350
diff changeset
   210
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   211
frag: pickle
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   212
	@if test ! -d $(BUILDDIR)/frag; then mkdir $(BUILDDIR)/frag; fi
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   213
	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
   214
	cp -r $(BUILDDIR)/pickle/_images $(BUILDDIR)/frag
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   215
8683
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8658
diff changeset
   216
html:  $(IMAGES) 
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   217
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   218
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   219
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   220
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   221
dirhtml:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   222
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   223
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   224
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   225
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   226
singlehtml:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   227
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   228
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   229
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   230
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   231
pickle:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   232
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
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; now you can process the pickle files."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   235
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   236
json:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   237
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
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; now you can process the JSON files."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   240
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   241
htmlhelp:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   242
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
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 "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
   245
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   246
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   247
qthelp:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   248
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   249
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   250
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   251
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   252
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ns-3.qhcp"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   253
	@echo "To view the help file:"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   254
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ns-3.qhc"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   255
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   256
devhelp:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   257
	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   258
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   259
	@echo "Build finished."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   260
	@echo "To view the help file:"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   261
	@echo "# mkdir -p $$HOME/.local/share/devhelp/ns-3"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   262
	@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
   263
	@echo "# devhelp"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   264
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   265
epub:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   266
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   267
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   268
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   269
8683
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8658
diff changeset
   270
latex:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   271
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   272
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   273
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   274
	@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
   275
	      "(use \`make latexpdf' here to do that automatically)."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   276
8683
c11f500b73a4 fixed lte+antenna docs in models library
Nicola Baldo <nbaldo@cttc.es>
parents: 8658
diff changeset
   277
latexpdf:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   278
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   279
	@echo "Running LaTeX files through pdflatex..."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   280
	make -C $(BUILDDIR)/latex all-pdf
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   281
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   282
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   283
text:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   284
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   285
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   286
	@echo "Build finished. The text files are in $(BUILDDIR)/text."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   287
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   288
man:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   289
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   290
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   291
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   292
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   293
changes:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   294
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   295
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   296
	@echo "The overview file is in $(BUILDDIR)/changes."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   297
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   298
linkcheck:  $(IMAGEs)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   299
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   300
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   301
	@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
   302
	      "or in $(BUILDDIR)/linkcheck/output.txt."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   303
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   304
doctest:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   305
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   306
	@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
   307
	      "results in $(BUILDDIR)/doctest/output.txt."
8703
e3b6612b0552 support make clean properly for standalone LTE docs
Nicola Baldo <nbaldo@cttc.es>
parents: 8702
diff changeset
   308