Fix Sphinx warnings
authorPeter D. Barnes, Jr. <barnes26@llnl.gov>
Tue, 31 Jul 2012 17:31:49 -0700
changeset 8947 2f79f33953a3
parent 8946 61b1f4bc700c
child 8948 8b2e2024ead7
child 8949 483f52d90d81
Fix Sphinx warnings
doc/manual/source/how-to-write-tests.rst
src/antenna/doc/source/antenna-design.rst
src/buildings/doc/source/buildings-references.rst
src/buildings/doc/source/conf.py
src/dsr/doc/dsr.rst
src/lte/doc/source/conf.py
src/lte/doc/source/lte-references.rst
--- a/doc/manual/source/how-to-write-tests.rst	Wed Jun 13 18:45:58 2012 -0700
+++ b/doc/manual/source/how-to-write-tests.rst	Tue Jul 31 17:31:49 2012 -0700
@@ -75,7 +75,7 @@
   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
 ***********************************************
--- a/src/antenna/doc/source/antenna-design.rst	Wed Jun 13 18:45:58 2012 -0700
+++ b/src/antenna/doc/source/antenna-design.rst	Tue Jul 31 17:31:49 2012 -0700
@@ -92,7 +92,7 @@
 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 @@
    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.
 
 
--- a/src/buildings/doc/source/buildings-references.rst	Wed Jun 13 18:45:58 2012 -0700
+++ b/src/buildings/doc/source/buildings-references.rst	Tue Jul 31 17:31:49 2012 -0700
@@ -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.
 
--- a/src/buildings/doc/source/conf.py	Wed Jun 13 18:45:58 2012 -0700
+++ b/src/buildings/doc/source/conf.py	Tue Jul 31 17:31:49 2012 -0700
@@ -38,7 +38,7 @@
 #source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = 'buildings'
 
 # General information about the project.
 project = u'LENA'
--- a/src/dsr/doc/dsr.rst	Wed Jun 13 18:45:58 2012 -0700
+++ b/src/dsr/doc/dsr.rst	Tue Jul 31 17:31:49 2012 -0700
@@ -74,15 +74,18 @@
 ======================
 
 * 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 @@
 
 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.
--- a/src/lte/doc/source/conf.py	Wed Jun 13 18:45:58 2012 -0700
+++ b/src/lte/doc/source/conf.py	Tue Jul 31 17:31:49 2012 -0700
@@ -37,7 +37,7 @@
 #source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = 'lte'
 
 # General information about the project.
 project = u'LENA'
--- a/src/lte/doc/source/lte-references.rst	Wed Jun 13 18:45:58 2012 -0700
+++ b/src/lte/doc/source/lte-references.rst	Tue Jul 31 17:31:49 2012 -0700
@@ -1,5 +1,8 @@
 .. include:: replace.txt
 
+=================================
+References
+=================================
 
 .. [TS25814] 3GPP TS 25.814 "Physical layer aspect for evolved Universal Terrestrial Radio Access"