src/wifi/doc/Makefile
author Tom Henderson <tomh@tomh.org>
Thu, 14 Jan 2016 14:23:17 -0800
changeset 11682 085c4ff7a60f
parent 11465 5a50e80cdf32
child 11683 9142266fbb25
permissions -rw-r--r--
improve WifiPhy documentation
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
11465
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     1
EPSTOPDF = epstopdf
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     2
DIA = dia
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     3
DOT = dot
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     4
CONVERT = convert -density 250
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     5
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     6
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     7
SOURCE = source
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     8
FIGURES = $(SOURCE)/figures
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     9
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    10
# specify dia figures from which .png and .pdf figures need to be built
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    11
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    12
IMAGES_DIA = \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    13
	$(FIGURES)/snir.dia \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    14
	$(FIGURES)/WifiArchitecture.dia
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    15
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    16
# specify eps figures from which .png and .pdf figures need to be built
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    17
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    18
IMAGES_EPS = \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    19
	$(FIGURES)/snir.eps \
11682
085c4ff7a60f improve WifiPhy documentation
Tom Henderson <tomh@tomh.org>
parents: 11465
diff changeset
    20
	$(FIGURES)/WifiArchitecture.eps \
085c4ff7a60f improve WifiPhy documentation
Tom Henderson <tomh@tomh.org>
parents: 11465
diff changeset
    21
        $(FIGURES)/clear-channel.eps \
085c4ff7a60f improve WifiPhy documentation
Tom Henderson <tomh@tomh.org>
parents: 11465
diff changeset
    22
        $(FIGURES)/nist-frame-success-rate.eps
11465
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    23
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    24
# rescale pdf figures as necessary
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    25
$(FIGURES)/snir.pdf_width = 3in
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    26
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    27
IMAGES_NOBUILD = 
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    28
# IMAGES_NOBUILD = $(FIGURES)/fading_pedestrian.png \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    29
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    30
IMAGES_BUILD = \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    31
	${IMAGES_DIA:.dia=.eps} \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    32
	${IMAGES_DIA:.dia=.png} \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    33
	${IMAGES_DIA:.dia=.pdf} \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    34
	${IMAGES_EPS:.eps=.png} \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    35
	${IMAGES_EPS:.eps=.pdf} 
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    36
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    37
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    38
IMAGES = $(IMAGES_NOBUILD) $(IMAGES_BUILD)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    39
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    40
RESCALE = ../../../utils/rescale-pdf.sh
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    41
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    42
%.eps : %.dia; $(DIA) -t eps $< -e $@
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    43
%.png : %.dia; $(DIA) -t png $< -e $@
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    44
%.png : %.eps; $(CONVERT) $< $@
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    45
%.pdf : %.eps
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    46
	$(EPSTOPDF) $< -o=$@
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    47
	if test x$($@_width) != x; then $(RESCALE) $($@_width) $@ ; fi
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    48
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    49
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    50
# You can set these variables from the command line.
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    51
SPHINXOPTS    =
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    52
SPHINXBUILD   = sphinx-build
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    53
PAPER         =
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    54
BUILDDIR      = build
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    55
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    56
# Internal variables.
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    57
PAPEROPT_a4     = -D latex_paper_size=a4
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    58
PAPEROPT_letter = -D latex_paper_size=letter
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    59
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCE) 
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    60
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    61
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    62
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    63
help:
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    64
	@echo "Please use \`make <target>' where <target> is one of"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    65
	@echo "  html       to make standalone HTML files"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    66
	@echo "  dirhtml    to make HTML files named index.html in directories"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    67
	@echo "  singlehtml to make a single large HTML file"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    68
	@echo "  pickle     to make pickle files"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    69
	@echo "  json       to make JSON files"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    70
	@echo "  htmlhelp   to make HTML files and a HTML help project"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    71
	@echo "  qthelp     to make HTML files and a qthelp project"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    72
	@echo "  devhelp    to make HTML files and a Devhelp project"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    73
	@echo "  epub       to make an epub"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    74
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    75
	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    76
	@echo "  text       to make text files"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    77
	@echo "  man        to make manual pages"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    78
	@echo "  changes    to make an overview of all changed/added/deprecated items"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    79
	@echo "  linkcheck  to check all external links for integrity"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    80
	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    81
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    82
clean:
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    83
	-rm -rf $(BUILDDIR)/*
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    84
	-rm -f $(IMAGES_BUILD)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    85
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    86
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    87
images: $(IMAGES_NOBUILD) $(IMAGES_BUILD)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    88
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    89
frag: pickle
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    90
	@if test ! -d $(BUILDDIR)/frag; then mkdir $(BUILDDIR)/frag; fi
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    91
	pushd $(BUILDDIR)/frag && ../../pickle-to-xml.py ../pickle/index.fpickle  > navigation.xml && popd
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    92
	cp -r $(BUILDDIR)/pickle/_images $(BUILDDIR)/frag
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    93
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    94
html:  $(IMAGES) 
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    95
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    96
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    97
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    98
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    99
dirhtml:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   100
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   101
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   102
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   103
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   104
singlehtml:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   105
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   106
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   107
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   108
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   109
pickle:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   110
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   111
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   112
	@echo "Build finished; now you can process the pickle files."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   113
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   114
json:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   115
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   116
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   117
	@echo "Build finished; now you can process the JSON files."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   118
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   119
htmlhelp:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   120
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   121
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   122
	@echo "Build finished; now you can run HTML Help Workshop with the" \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   123
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   124
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   125
qthelp:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   126
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   127
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   128
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   129
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   130
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ns-3.qhcp"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   131
	@echo "To view the help file:"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   132
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ns-3.qhc"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   133
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   134
devhelp:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   135
	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   136
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   137
	@echo "Build finished."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   138
	@echo "To view the help file:"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   139
	@echo "# mkdir -p $$HOME/.local/share/devhelp/ns-3"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   140
	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ns-3"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   141
	@echo "# devhelp"
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   142
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   143
epub:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   144
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   145
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   146
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   147
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   148
latex:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   149
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   150
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   151
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   152
	@echo "Run \`make' in that directory to run these through (pdf)latex" \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   153
	      "(use \`make latexpdf' here to do that automatically)."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   154
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   155
latexpdf:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   156
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   157
	@echo "Running LaTeX files through pdflatex..."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   158
	make -C $(BUILDDIR)/latex all-pdf
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   159
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   160
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   161
text:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   162
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   163
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   164
	@echo "Build finished. The text files are in $(BUILDDIR)/text."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   165
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   166
man:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   167
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   168
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   169
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   170
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   171
changes:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   172
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   173
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   174
	@echo "The overview file is in $(BUILDDIR)/changes."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   175
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   176
linkcheck:  $(IMAGEs)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   177
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   178
	@echo
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   179
	@echo "Link check complete; look for any errors in the above output " \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   180
	      "or in $(BUILDDIR)/linkcheck/output.txt."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   181
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   182
doctest:  $(IMAGES)
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   183
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   184
	@echo "Testing of doctests in the sources finished, look at the " \
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   185
	      "results in $(BUILDDIR)/doctest/output.txt."
5a50e80cdf32 enable wifi module documentation to be built standalone
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
   186