Run utils/trim-trailing-whitespace.py on codebase
This commit is contained in:
@@ -102,9 +102,9 @@ SOURCES = \
|
||||
$(SRC)/sixlowpan/doc/sixlowpan.rst \
|
||||
$(SRC)/lr-wpan/doc/lr-wpan.rst \
|
||||
|
||||
# list all model library figure files that need to be copied to
|
||||
# list all model library figure files that need to be copied to
|
||||
# $SOURCETEMP/figures. For each figure to be included in all
|
||||
# documentation formats (html, latex...) the following formats are supported:
|
||||
# documentation formats (html, latex...) the following formats are supported:
|
||||
# 1) a single .dia file (preferred option, because it can be edited)
|
||||
# 2) a single .eps file
|
||||
# 3) both a .pdf and .png file
|
||||
@@ -472,7 +472,7 @@ IMAGES_EPS = \
|
||||
# rescale pdf figures as necessary
|
||||
$(FIGURES)/testbed.pdf_width = 5in
|
||||
$(FIGURES)/emulated-channel.pdf_width = 6in
|
||||
$(FIGURES)/antenna-coordinate-system.pdf_width = 7cm
|
||||
$(FIGURES)/antenna-coordinate-system.pdf_width = 7cm
|
||||
$(FIGURES)/node.pdf_width = 5in
|
||||
$(FIGURES)/packet.pdf_width = 4in
|
||||
$(FIGURES)/buffer.pdf_width = 15cm
|
||||
@@ -501,7 +501,7 @@ $(FIGURES)/fr-soft-frequency-reuse-scheme-v1.pdf_width = 8cm
|
||||
$(FIGURES)/fr-soft-frequency-reuse-scheme-v2.pdf_width = 8cm
|
||||
$(FIGURES)/fr-strict-frequency-reuse-scheme.pdf_width = 8cm
|
||||
$(FIGURES)/ffr-distributed-scheme.pdf_width = 8cm
|
||||
$(FIGURES)/lte-arch-enb-data.pdf_width = 6cm
|
||||
$(FIGURES)/lte-arch-enb-data.pdf_width = 6cm
|
||||
$(FIGURES)/lte-arch-enb-ctrl.pdf_width = 10cm
|
||||
$(FIGURES)/lte-arch-ue-data.pdf_width = 6cm
|
||||
$(FIGURES)/lte-arch-ue-ctrl.pdf_width = 10cm
|
||||
@@ -561,7 +561,7 @@ BUILDDIR = build
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCETEMP)
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCETEMP)
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
|
||||
|
||||
@@ -587,8 +587,8 @@ help:
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
|
||||
copy-sources: $(SOURCES)
|
||||
@mkdir -p $(SOURCETEMP)
|
||||
@mkdir -p $(FIGURES)
|
||||
@mkdir -p $(SOURCETEMP)
|
||||
@mkdir -p $(FIGURES)
|
||||
@cp -r -p $(SOURCES) $(SOURCETEMP)
|
||||
@cp -r -p $(SOURCEFIGS) $(FIGURES)
|
||||
|
||||
@@ -601,7 +601,7 @@ frag: pickle
|
||||
pushd $(BUILDDIR)/frag && ../../pickle-to-xml.py ../pickle/index.fpickle > navigation.xml && popd
|
||||
cp -r $(BUILDDIR)/pickle/_images $(BUILDDIR)/frag
|
||||
|
||||
html: copy-sources $(IMAGES)
|
||||
html: copy-sources $(IMAGES)
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
@@ -24,7 +24,7 @@ import sys, os
|
||||
|
||||
# To change default code-block format in Latex to footnotesize (8pt)
|
||||
# Tip from https://stackoverflow.com/questions/9899283/how-do-you-change-the-code-example-font-size-in-latex-pdf-output-with-sphinx/9955928
|
||||
# Note: sizes are \footnotesize (8pt), \small (9pt), and \normalsize (10pt).
|
||||
# Note: sizes are \footnotesize (8pt), \small (9pt), and \normalsize (10pt).
|
||||
|
||||
#from sphinx.highlighting import PygmentsBridge
|
||||
#from pygments.formatters.latex import LatexFormatter
|
||||
@@ -274,7 +274,7 @@ latex_elements = {
|
||||
# (double backquotes) to either \footnotesize (8pt) or \small (9pt)
|
||||
#
|
||||
# See above to change the font size of verbatim code blocks
|
||||
#
|
||||
#
|
||||
# 'preamble': '',
|
||||
'preamble': u'''\\usepackage{amssymb}
|
||||
\\definecolor{VerbatimBorderColor}{rgb}{1,1,1}
|
||||
|
||||
@@ -24,7 +24,7 @@ One of the use-cases we want to support is that of a testbed. A concrete example
|
||||
of an environment of this kind is the ORBIT testbed. ORBIT is a laboratory
|
||||
emulator/field trial network arranged as a two dimensional grid of 400 802.11
|
||||
radio nodes. We integrate with ORBIT by using their "imaging" process to load
|
||||
and run |ns3| simulations on the ORBIT array. We can use our
|
||||
and run |ns3| simulations on the ORBIT array. We can use our
|
||||
``EmuFdNetDevice``
|
||||
to drive the hardware in the testbed and we can accumulate results either using
|
||||
the |ns3| tracing and logging functions, or the native ORBIT data gathering
|
||||
@@ -36,7 +36,7 @@ A simulation of this kind is shown in the following figure:
|
||||
.. _testbed:
|
||||
|
||||
.. figure:: figures/testbed.*
|
||||
|
||||
|
||||
Example Implementation of Testbed Emulation.
|
||||
|
||||
You can see that there are separate hosts, each running a subset of a "global"
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
ns-3 Model Library
|
||||
==================
|
||||
|
||||
This is the *ns-3 Model Library* documentation. Primary documentation for the ns-3 project is
|
||||
This is the *ns-3 Model Library* documentation. Primary documentation for the ns-3 project is
|
||||
available in five forms:
|
||||
|
||||
* `ns-3 Doxygen <https://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
|
||||
* Tutorial, Manual, and Model Library *(this document)* for the `latest release <https://www.nsnam.org/documentation/latest/>`_ and `development tree <https://www.nsnam.org/documentation/development-tree/>`_
|
||||
* `ns-3 wiki <https://www.nsnam.org/wiki>`_
|
||||
* `ns-3 wiki <https://www.nsnam.org/wiki>`_
|
||||
|
||||
This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <http://sphinx.pocoo.org/>`_ and is maintained in the
|
||||
``doc/models`` directory of ns-3's source code.
|
||||
|
||||
@@ -12,22 +12,22 @@ It is important to distinguish between **modules** and **models**:
|
||||
the modules (libraries) they need to conduct their simulation.
|
||||
|
||||
* |ns3| *models* are abstract representations of real-world objects,
|
||||
protocols, devices, etc.
|
||||
protocols, devices, etc.
|
||||
|
||||
An |ns3| module may consist of more than one model (for instance, the
|
||||
:mod:`internet` module contains models for both TCP and UDP). In general,
|
||||
ns-3 models do not span multiple software modules, however.
|
||||
ns-3 models do not span multiple software modules, however.
|
||||
|
||||
This manual provides documentation about the models of |ns3|. It
|
||||
This manual provides documentation about the models of |ns3|. It
|
||||
complements two other sources of documentation concerning models:
|
||||
|
||||
* the model APIs are documented, from a programming perspective, using
|
||||
`Doxygen <http://www.doxygen.org>`_. Doxygen for ns-3 models is available
|
||||
`on the project web server <http://www.nsnam.org/docs/doxygen/index.html>`_.
|
||||
`on the project web server <http://www.nsnam.org/docs/doxygen/index.html>`_.
|
||||
|
||||
* the |ns3| core is documented in the developer's manual. |ns3| models make
|
||||
use of the facilities of the core, such as attributes, default values,
|
||||
random numbers, test frameworks, etc. Consult the
|
||||
use of the facilities of the core, such as attributes, default values,
|
||||
random numbers, test frameworks, etc. Consult the
|
||||
`main web site <http://www.nsnam.org>`_ to find copies of the manual.
|
||||
|
||||
Finally, additional documentation about various aspects of |ns3| may
|
||||
@@ -35,7 +35,7 @@ exist on the `project wiki <http://www.nsnam.org/wiki>`_.
|
||||
|
||||
A sample outline of how to write model library documentation can be
|
||||
found by executing the ``create-module.py`` program and looking at the
|
||||
template created in the file ``new-module/doc/new-module.rst``.
|
||||
template created in the file ``new-module/doc/new-module.rst``.
|
||||
|
||||
.. sourcecode:: bash
|
||||
|
||||
@@ -46,8 +46,8 @@ The remainder of this document is organized alphabetically by module name.
|
||||
|
||||
If you are new to |ns3|, you might first want to read below about the network
|
||||
module, which contains some fundamental models for the simulator.
|
||||
The packet model, models for different address formats, and abstract
|
||||
base classes for objects such as nodes, net devices, channels, sockets, and
|
||||
The packet model, models for different address formats, and abstract
|
||||
base classes for objects such as nodes, net devices, channels, sockets, and
|
||||
applications are discussed there.
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user