From a8205362b879e408df52e61b4919199f0c5d11b3 Mon Sep 17 00:00:00 2001 From: "Peter D. Barnes, Jr." Date: Tue, 31 Jul 2012 17:31:49 -0700 Subject: [PATCH] Fix Sphinx warnings --- doc/manual/source/how-to-write-tests.rst | 2 +- src/antenna/doc/source/antenna-design.rst | 4 ++-- .../doc/source/buildings-references.rst | 4 ++++ src/buildings/doc/source/conf.py | 2 +- src/dsr/doc/dsr.rst | 20 +++++++++++-------- src/lte/doc/source/conf.py | 2 +- src/lte/doc/source/lte-references.rst | 3 +++ 7 files changed, 24 insertions(+), 13 deletions(-) diff --git a/doc/manual/source/how-to-write-tests.rst b/doc/manual/source/how-to-write-tests.rst index 69788bbe0..ffaa5088a 100644 --- a/doc/manual/source/how-to-write-tests.rst +++ b/doc/manual/source/how-to-write-tests.rst @@ -75,7 +75,7 @@ Output such as below should be produced: PASS: TestSuite router 1 of 1 tests passed (1 passed, 0 skipped, 0 failed, 0 crashed, 0 valgrind errors) -/* see src/lte/test/test-lte-antenna.cc for a worked example */ +See src/lte/test/test-lte-antenna.cc for a worked example. How to add an example program to the test suite *********************************************** diff --git a/src/antenna/doc/source/antenna-design.rst b/src/antenna/doc/source/antenna-design.rst index 2c06a8387..511d27e81 100644 --- a/src/antenna/doc/source/antenna-design.rst +++ b/src/antenna/doc/source/antenna-design.rst @@ -92,7 +92,7 @@ pattern. ParabolicAntennaModel +++++++++++++++++++++ -This model is based on the parabolic approximation of the main lobe radiation pattern. It is often used in the context of cellular system to model the radiation pattern of a cell sector, see for instance [R4-092042]_ and [Calcev]_. The antenna gain in dB is determined as: +This model is based on the parabolic approximation of the main lobe radiation pattern. It is often used in the context of cellular system to model the radiation pattern of a cell sector, see for instance [R4-092042a]_ and [Calcev]_. The antenna gain in dB is determined as: .. math:: @@ -117,7 +117,7 @@ antenna. CDMA Networks", in Proc. of the 2nd Annual International Wireless Internet Conference (WICON), 2006 -.. [R4-092042] 3GPP TSG RAN WG4 (Radio) Meeting #51, R4-092042, Simulation +.. [R4-092042a] 3GPP TSG RAN WG4 (Radio) Meeting #51, R4-092042, Simulation assumptions and parameters for FDD HeNB RF requirements. diff --git a/src/buildings/doc/source/buildings-references.rst b/src/buildings/doc/source/buildings-references.rst index e7905d79e..a9b92e34b 100644 --- a/src/buildings/doc/source/buildings-references.rst +++ b/src/buildings/doc/source/buildings-references.rst @@ -1,6 +1,10 @@ .. include:: replace.txt +##################################################### +References +##################################################### + .. [turkmani] Turkmani A.M.D., J.D. Parson and D.G. Lewis, "Radio propagation into buildings at 441, 900 and 1400 MHz", in Proc. of 4th Int. Conference on Land Mobile Radio, 1987. diff --git a/src/buildings/doc/source/conf.py b/src/buildings/doc/source/conf.py index 8d5800b23..8b819bfad 100644 --- a/src/buildings/doc/source/conf.py +++ b/src/buildings/doc/source/conf.py @@ -38,7 +38,7 @@ source_suffix = '.rst' #source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = 'buildings' # General information about the project. project = u'LENA' diff --git a/src/dsr/doc/dsr.rst b/src/dsr/doc/dsr.rst index ee4042b8a..d80d40db2 100644 --- a/src/dsr/doc/dsr.rst +++ b/src/dsr/doc/dsr.rst @@ -74,15 +74,18 @@ Implementation changes ====================== * The DsrFsHeader has added 3 fields: message type, source id, destination id, -and these changes only for post-processing -** message type is used to identify the data packet from control packet -** source id is used to identify the real source of the data packet since we have to deliver the packet hop-by-hop and the ipv4header is not carrying the real source and destination ip address as needed -** destination id is for same reason of above + and these changes only for post-processing + + * message type is used to identify the data packet from control packet + * source id is used to identify the real source of the data packet since we have to deliver the packet hop-by-hop and the ipv4header is not carrying the real source and destination ip address as needed + * destination id is for same reason of above + * Route Reply header is not word-aligned in DSR rfc, change it to word-aligned in implementation * DSR works as a shim header between transport and network protocol, it needs its own forwarding mechanism, we are changing the packet transmission to hop-by-hop delivery, so we added two fields in dsr fixed header to notify packet delivery - 1. message type to notify the type of this packet: data packet or control one - 2. source id to identify the real source address of this packet - 3. destination id to identify the real destination + + # message type to notify the type of this packet: data packet or control one + # source id to identify the real source address of this packet + # destination id to identify the real destination Current Route Cache implementation ================================== @@ -124,7 +127,8 @@ Examples The example can be found in ``src/dsr/examples/``: -* dsr.cc use DSR as routing protocol within a traditional MANETs environment[3]. +* dsr.cc use DSR as routing protocol within a traditional MANETs environment[3]. + DSR is also built in the routing comparison case in ``examples/routing/``: * ``manet-routing-compare.cc`` is a comparison case with built in MANET routing protocols and can generate its own results. diff --git a/src/lte/doc/source/conf.py b/src/lte/doc/source/conf.py index 96a7880fc..041f928fd 100644 --- a/src/lte/doc/source/conf.py +++ b/src/lte/doc/source/conf.py @@ -37,7 +37,7 @@ source_suffix = '.rst' #source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = 'lte' # General information about the project. project = u'LENA' diff --git a/src/lte/doc/source/lte-references.rst b/src/lte/doc/source/lte-references.rst index 03baaef93..ce2ef455c 100644 --- a/src/lte/doc/source/lte-references.rst +++ b/src/lte/doc/source/lte-references.rst @@ -1,5 +1,8 @@ .. include:: replace.txt +================================= +References +================================= .. [TS25814] 3GPP TS 25.814 "Physical layer aspect for evolved Universal Terrestrial Radio Access"