More on rst

Author: pgleeson

examples/document.md

@@ -43,7 +43,7 @@ A model for documents
 
 ## Section
 
-A model of a section of the document
+A model of a section of the document. Will contain a <a href="#paragraph">Paragraph</a> or two
 
 ### Allowed parameters
 <table>
@@ -81,7 +81,7 @@ A model of a paragraph
   <tr>
     <td><b>contents</b></td>
     <td>str</td>
-    <td><i>Paragraph contents</i></td>
+    <td><i>Paragraph contents, which make up the <a href="#section">Section</a>s.</i></td>
   </tr>
 
 </table>

examples/document.py

@@ -22,7 +22,7 @@ def __init__(self, **kwargs):
 
 class Section(BaseWithId):
 
-    _definition = "A model of a section of the document"
+    _definition = "A model of a section of the document. Will contain a _Paragraph_ or two"
 
     def __init__(self, **kwargs):
 
@@ -37,7 +37,7 @@ class Paragraph(Base):
 
     def __init__(self, **kwargs):
 
-        self.add_allowed_field("contents", "Paragraph contents", str)
+        self.add_allowed_field("contents", "Paragraph contents, which make up the _Section_s.", str)
 
         super(Paragraph, self).__init__(**kwargs)
 

examples/document.rst

@@ -27,7 +27,7 @@ Allowed child    Data Type              Description
 =======
 Section
 =======
-A model of a section of the document
+A model of a section of the document. Will contain a Paragraph or two
 
 Allowed parameters
 ==================
@@ -56,9 +56,9 @@ A model of a paragraph
 Allowed parameters
 ==================
 
-===============  ===========  ====================
+===============  ===========  =================================================
 Allowed field    Data Type    Description
-===============  ===========  ====================
-**contents**     str          *Paragraph contents*
-===============  ===========  ====================
+===============  ===========  =================================================
+**contents**     str          *Paragraph contents, which make up the Sections.*
+===============  ===========  =================================================
 

modelspec/BaseTypes.py

@@ -382,6 +382,7 @@ def generate_documentation(self, format=MARKDOWN_FORMAT):
         rst_url_format = '`%s <%s>`_'
 
         def insert_links(text, format=MARKDOWN_FORMAT):
+
             if not "_" in text:
                 return text
             if '"' in text:
@@ -394,7 +395,9 @@ def insert_links(text, format=MARKDOWN_FORMAT):
                 if format==MARKDOWN_FORMAT:
                     text2 += '%s<a href="#%s">%s</a>' % (pre, type.lower(), type)
                 elif format==RST_FORMAT:
-                    text2 += ('%s'+rst_url_format) % (pre, type, '#'+type.lower())
+                    #text2 += ('%s'+rst_url_format) % (pre, type, '#'+type.lower # problem with handling links ending with s e.g. _Graph_s
+
+                    text2 += ('%s%s') % (pre, type) # temp hack... problem with handling links ending with s e.g. _Graph_s
             if int(len(split) / 2.0) != len(split) / 2.0:
                 text2 += split[-1]
             return text2