Changeset 987

Timestamp:

Jul 2, 2012 7:23:59 AM (11 years ago)

Author:

jemian

Message:

refs #8, add .mac files to the index

Location:

specdomain/trunk/src/specdomain/sphinxcontrib

Files:

• specdomain.py (modified) (5 diffs)
• specmacrofileparser.py (modified) (1 diff)

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

@@ -31 +31 @@
 from sphinx.domains import Domain, ObjType, Index       #@UnusedImport
 from sphinx.util.compat import Directive                #@UnusedImport
-from sphinx.util.nodes import make_refnode, nested_parse_with_titles
+from sphinx.util.nodes import make_refnode, nested_parse_with_titles    #@UnusedImport
 from sphinx.util.docfields import Field, TypedField
 from sphinx.util.docstrings import prepare_docstring    #@UnusedImport
@@ -42 +42 @@
 #from sphinx.util.pycompat import base_exception, class_types
 from specmacrofileparser import SpecMacrofileParser
-from docutils.statemachine import ViewList
+from docutils.statemachine import ViewList    #@UnusedImport
 
 
@@ -51 +51 @@
 word_match                  = r'((?:[a-z_]\w*))'
 cdef_match                  = r'(cdef)'
-extended_comment_flag       = r'\"\"\"'
 
 
@@ -65 +64 @@
 spec_cdef_name_sig_re = re.compile(double_quote_string_match, 
                                    re.IGNORECASE|re.DOTALL)
-
-
-spec_extended_comment_flag_sig_re = re.compile(extended_comment_flag, 
-                                               re.IGNORECASE|re.DOTALL)
-spec_extended_comment_start_sig_re = re.compile(r'^'
-                                                + non_greedy_filler
-                                                + extended_comment_flag, 
-                                                re.IGNORECASE|re.DOTALL)
-spec_extended_comment_block_sig_re = re.compile(r'^'
-                                                + non_greedy_filler
-                                                + extended_comment_flag
-                                                + r'(' + non_greedy_filler + r')'
-                                                + extended_comment_flag
-                                                + non_greedy_filler
-                                                + r'$', 
-                                                re.IGNORECASE|re.DOTALL|re.MULTILINE)
 
 
@@ -150 +133 @@
         # This works for now.
         self.add_line(u'', '<autodoc>')
+        self.add_line(u'.. index:: SPEC macro file; %s' % macrofile, '<autodoc>')
+        self.add_line(u'', '<autodoc>')
         line = 'source code:  :download:`%s <%s>`' % (macrofile, macrofile)
         self.add_line(line, macrofile)
-        # TODO: Add each .mac file name to the Index
 
         self.add_line(u'', '<autodoc>')

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

@@ -369 +369 @@
         if not self.state == 'parsed':
             raise RuntimeWarning, "state = %s, should be 'parsed'" % self.filename
+        return self._simple_ReST_renderer()
+
+    def _simple_ReST_renderer(self):
+        """create a simple ReStructured Text rendition of the findings"""
+        if not self.state == 'parsed':
+            raise RuntimeWarning, "state = %s, should be 'parsed'" % self.filename
             
-        s = []
         declarations = []       # variables and constants
         macros = []             # def, cdef, and rdef macros
         functions = []          # def and rdef function macros
+        title = 'Extended Comments'
+        s = ['', title, '='*len(title), ]
         for r in self.findings:
             if r['objtype'] == 'extended comment':