src/buildings/doc/Makefile
author Nicola Baldo <nbaldo@cttc.es>
Wed, 26 Oct 2011 18:53:54 +0200
changeset 8260 c3bf1b481daf
parent 8171 src/lte/doc/Makefile@2e0988d19ecc
child 8307 e059b2c2f2e4
child 8390 fb2bef5bb0e2
permissions -rw-r--r--
buildings doc can now be built standalone and within models library doc
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
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
     6
SOURCE = source
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
     7
FIGURES = $(SOURCE)/figures
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     8
7325
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
     9
# 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
    10
# generated (all dia and eps figures)
8260
c3bf1b481daf buildings doc can now be built standalone and within models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8171
diff changeset
    11
IMAGES_EPS = 
8118
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    12
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    13
# specify figures for build process (all eps figures)
8260
c3bf1b481daf buildings doc can now be built standalone and within models library doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8171
diff changeset
    14
GRAPHS_EPS = 
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    15
7325
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
    16
# rescale pdf figures as necessary
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    17
$(FIGURES)/testbed.pdf_width = 5in
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    18
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    19
IMAGES_PNG = ${IMAGES_EPS:.eps=.png}
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    20
IMAGES_PDF = ${IMAGES_EPS:.eps=.pdf}
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    21
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    22
IMAGES = $(IMAGES_EPS) $(IMAGES_PNG) $(IMAGES_PDF)
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    23
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    24
%.eps : %.dia; $(DIA) -t eps $< -e $@
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    25
%.png : %.dia; $(DIA) -t png $< -e $@
7325
317a51a70b60 [bug 1196] support for eps figures
Nicola Baldo <nbaldo@cttc.es>
parents: 7306
diff changeset
    26
%.png : %.eps; $(CONVERT) $< $@
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    27
%.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
    28
8118
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    29
GRAPHS_PNG = ${GRAPHS_EPS:.eps=.png}
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    30
GRAPHS_PDF = ${GRAPHS_EPS:.eps=.pdf}
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    31
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    32
GRAPHS = $(GRAPHS_EPS) $(GRAPHS_PNG) $(GRAPHS_PDF)
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    33
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    34
%.png : %.eps; $(CONVERT) $< $@
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    35
%.pdf : %.eps; $(EPSTOPDF) $< -o=$@; if test x$($@_width) != x; then TMPFILE=`mktemp`; ./rescale-pdf.sh $($@_width) $@ $${TMPFILE} && mv $${TMPFILE} $@; fi
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    36
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    37
# You can set these variables from the command line.
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    38
SPHINXOPTS    =
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    39
SPHINXBUILD   = sphinx-build
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    40
PAPER         =
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    41
BUILDDIR      = build
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    42
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    43
# Internal variables.
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    44
PAPEROPT_a4     = -D latex_paper_size=a4
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    45
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
    46
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCE) 
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    47
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    48
.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
    49
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    50
help:
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    51
	@echo "Please use \`make <target>' where <target> is one of"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    52
	@echo "  html       to make standalone HTML files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    53
	@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
    54
	@echo "  singlehtml to make a single large HTML file"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    55
	@echo "  pickle     to make pickle files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    56
	@echo "  json       to make JSON files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    57
	@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
    58
	@echo "  qthelp     to make HTML files and a qthelp project"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    59
	@echo "  devhelp    to make HTML files and a Devhelp project"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    60
	@echo "  epub       to make an epub"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    61
	@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
    62
	@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
    63
	@echo "  text       to make text files"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    64
	@echo "  man        to make manual pages"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    65
	@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
    66
	@echo "  linkcheck  to check all external links for integrity"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    67
	@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
    68
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    69
clean:
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    70
	-rm -rf $(BUILDDIR)/*
8113
3fdf1f9caee9 clean only generated files
Manuel Requena <manuel.requena@cttc.es>
parents: 8101
diff changeset
    71
	-rm -f $(IMAGES_PNG)
3fdf1f9caee9 clean only generated files
Manuel Requena <manuel.requena@cttc.es>
parents: 8101
diff changeset
    72
	-rm -f $(IMAGES_PDF)
8118
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    73
	-rm -f $(GRAPHS_PNG)
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    74
	-rm -f $(GRAPHS_PDF)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    75
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    76
frag: pickle
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    77
	@if test ! -d $(BUILDDIR)/frag; then mkdir $(BUILDDIR)/frag; fi
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    78
	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
    79
	cp -r $(BUILDDIR)/pickle/_images $(BUILDDIR)/frag
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    80
8118
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
    81
html:  $(IMAGES) ${GRAPHS}
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    82
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    83
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    84
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    85
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
    86
dirhtml:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    87
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    88
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    89
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    90
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
    91
singlehtml:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    92
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    93
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    94
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    95
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
    96
pickle:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    97
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    98
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    99
	@echo "Build finished; now you can process the pickle files."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   100
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   101
json:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   102
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   103
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   104
	@echo "Build finished; now you can process the JSON files."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   105
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   106
htmlhelp:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   107
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   108
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   109
	@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
   110
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   111
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   112
qthelp:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   113
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   114
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   115
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   116
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   117
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ns-3.qhcp"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   118
	@echo "To view the help file:"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   119
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ns-3.qhc"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   120
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   121
devhelp:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   122
	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   123
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   124
	@echo "Build finished."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   125
	@echo "To view the help file:"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   126
	@echo "# mkdir -p $$HOME/.local/share/devhelp/ns-3"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   127
	@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
   128
	@echo "# devhelp"
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   129
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   130
epub:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   131
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   132
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   133
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   134
8118
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
   135
latex:  $(IMAGES) ${GRAPHS}
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   136
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   137
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   138
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   139
	@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
   140
	      "(use \`make latexpdf' here to do that automatically)."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   141
8118
3519d568f8e9 pdf and png files not needed anymore for eps figures
Manuel Requena <manuel.requena@cttc.es>
parents: 8113
diff changeset
   142
latexpdf:  $(IMAGES) ${GRAPHS}
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   143
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   144
	@echo "Running LaTeX files through pdflatex..."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   145
	make -C $(BUILDDIR)/latex all-pdf
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   146
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   147
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   148
text:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   149
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   150
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   151
	@echo "Build finished. The text files are in $(BUILDDIR)/text."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   152
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   153
man:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   154
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   155
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   156
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   157
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   158
changes:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   159
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   160
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   161
	@echo "The overview file is in $(BUILDDIR)/changes."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   162
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   163
linkcheck:  $(IMAGEs)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   164
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   165
	@echo
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   166
	@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
   167
	      "or in $(BUILDDIR)/linkcheck/output.txt."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   168
8101
426064e45a62 added possibility to build a stand-alone LTE doc
Nicola Baldo <nbaldo@cttc.es>
parents: 8100
diff changeset
   169
doctest:  $(IMAGES)
7204
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   170
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   171
	@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
   172
	      "results in $(BUILDDIR)/doctest/output.txt."
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   173
052d30ceb700 split manual; create model library
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   174