Changeset 989

Timestamp:

Jul 2, 2012 3:13:44 PM (11 years ago)

Author:

jemian

Message:

refs #8, still need to understand how the index is configured in the domain

Location:

specdomain/trunk/src/specdomain

Files:

• sphinxcontrib/specdomain.py (modified) (4 diffs)
• sphinxcontrib/specmacrofileparser.py (modified) (3 diffs)
• test/test_doc.rst (modified) (3 diffs)

specdomain/trunk/src/specdomain/sphinxcontrib/specdomain.py

@@ -190 +190 @@
         indextext = self._get_index_text(name)
         if indextext:
-            self.indexnode['entries'].append(('single', indextext,
-                                              targetname, ''))
+            self.indexnode['entries'].append(('single', indextext, targetname, ''))
+            self.indexnode['entries'].append(('single', sig, targetname, ''))
 
     def _get_index_text(self, name):
@@ -242 +242 @@
     # TODO: array variables are not handled at all
     # TODO: variables cited by *role* should link back to their *directive* declarations
-    #       probably need to override handle_signature() and add_target_and_index()
 
     def handle_signature(self, sig, signode):
@@ -248 +247 @@
         # TODO: Should it match a regular expression?
         # TODO: What if global or local?  
+        signode += addnodes.desc_name(sig, sig)
         return sig
 
@@ -253 +253 @@
         targetname = '%s-%s' % (self.objtype, name)
         signode['ids'].append(targetname)
-        # TODO: index entry here is at line before directive, now must get it right
         # TODO: role does not point back to it yet
         # http://sphinx.pocoo.org/markup/misc.html#directive-index

specdomain/trunk/src/specdomain/sphinxcontrib/specmacrofileparser.py

@@ -49 +49 @@
         Assume all extended comments contain ReST formatted comments, 
         *including initial section titles or transitions*.
-        The first and simplest thing to do is to read the .mac file and only extract
-        all the extended comments and add them as nodes to the current document.
     
     Assume macro definitions are not nested (but test for this).
+    
+    Assume macro files are small enough to load completely in memory.
         
     An additional step would be to parse for:
-    * def
-    * cdef
-    * rdef
+    * def    (done)
+    * cdef    (done)
+    * rdef    (done)
     * global    (done)
     * local    (done)
@@ -379 +379 @@
         macros = []             # def, cdef, and rdef macros
         functions = []          # def and rdef function macros
-        title = 'Extended Comments'
-        s = ['', title, '='*len(title), ]
+        #title = 'Extended Comments'
+        #s = ['', title, '='*len(title), ]
+        s = []
         for r in self.findings:
             if r['objtype'] == 'extended comment':
@@ -390 +391 @@
                 s.append( '' )
                 s.append(r['text'])
-            elif r['objtype'] in ('def', 'rdef', 'cdef'):
+            elif r['objtype'] in ('def', 'rdef', 'cdef', ):
                 macros.append(r)
+                s.append( '' )
+                s.append( '.. %s %s %s %d %d' % (self.filename, 
+                                              r['objtype'], 
+                                              r['name'], 
+                                              r['start_line'], 
+                                              r['end_line']) )
+                s.append( '' )
+                s.append( '.. rubric:: %s macro declaration' % r['objtype']  )
+                s.append( '' )
+                #s.append( '.. spec:%s:: %s %s' % ( r['objtype'], r['name'], r['args'],) )
+                s.append( '.. spec:%s:: %s' % ( r['objtype'], r['name'],) )
             elif r['objtype'] in ('function def', 'function rdef',):
+                # FIXME:  not getting here, such as for kohzuE_cmd()
                 functions.append(r)
+                s.append( '' )
+                s.append( '.. %s %s %s %d %d' % (self.filename, 
+                                              r['objtype'], 
+                                              r['name'], 
+                                              r['start_line'], 
+                                              r['end_line']) )
+                s.append( '' )
+                s.append( '.. rubric:: %s macro function declaration' % r['objtype']  )
+                s.append( '' )
+                s.append( '.. spec:%s:: %s(%s)' % ( r['objtype'], r['name'], r['args']) )
             elif r['objtype'] in ('local', 'global', 'constant'):
                 declarations.append(r)

specdomain/trunk/src/specdomain/test/test_doc.rst

@@ -94 +94 @@
            ``i`` is a local loop counter
 
+constant declaration:  
+
+        .. spec:local:: TWO_PI
+        
+           ``TWO_PI`` is the ratio of a circle's circumference to its diameter.
+
 array variable declaration: 
 
@@ -106 +112 @@
 * local variable declaration:   :spec:local:`i`
 * array variable declaration:   *--tba--*
-* constant declaration:                 *--tba--*
+* constant declaration:                 :spec:constant:`TWO_PI`
 
 
@@ -134 +140 @@
 * local variable, such as:      :spec:local:`i`
 * array variable declaration:   *--tba--*
-* constant declaration:                 *--tba--*
+* constant declaration:                 :spec:constant:`TWO_PI`
 
 Source code documentation