Changeset 964

Timestamp:

Jun 22, 2012 6:36:09 PM (11 years ago)

Author:

jemian

Message:

refs #8, clean up the imports, provide .mac source link from autodocumenter

Location:

specdomain/src/specdomain

Files:

• sphinxcontrib/specdomain.py (modified) (3 diffs)
• test/cdef-examples.mac.rst (modified) (1 diff)
• test/shutter.mac.rst (modified) (1 diff)
• test/test-battery.mac.rst (modified) (1 diff)

specdomain/src/specdomain/sphinxcontrib/specdomain.py

@@ -20 +20 @@
 import re
 import string                                           #@UnusedImport
-import sys
+import sys                                              #@UnusedImport
 
 from docutils import nodes                              #@UnusedImport
@@ -35 +35 @@
 from sphinx.util.docstrings import prepare_docstring    #@UnusedImport
 
-from docutils.statemachine import ViewList, string2lines
-import sphinx.util.nodes
+#from docutils.statemachine import ViewList, string2lines
+#import sphinx.util.nodes
 from sphinx.ext.autodoc import Documenter, bool_option
-from sphinx.util.inspect import getargspec, isdescriptor, safe_getmembers, \
-     safe_getattr, safe_repr
-from sphinx.util.pycompat import base_exception, class_types
+#from sphinx.util.inspect import getargspec, isdescriptor, safe_getmembers, \
+#     safe_getattr, safe_repr
+#from sphinx.util.pycompat import base_exception, class_types
 from specmacrofileparser import SpecMacrofileParser
 
 
+# TODO: merge these with specmacrofileparser.py
 match_all                   = r'.*'
 non_greedy_filler           = match_all + r'?'
@@ -166 +167 @@
         rest = prepare_docstring(extended_comment)
 
-        # TODO: Another step should (like for Python) attach source code and provide
-        #       links from each to highlighted source code blocks.
-
         #self.add_line(u'', '<autodoc>')
         #sig = self.format_signature()
         #self.add_directive_header(sig)
+        
+        # TODO: Another step should (like for Python) attach source code and provide
+        #       links from each to highlighted source code blocks.
+        # This works for now.
+        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>')
         for linenumber, line in enumerate(rest):

specdomain/src/specdomain/test/cdef-examples.mac.rst

@@ -5 +5 @@
 ====================================================
 
-source code:  :download:`cdef-examples.mac <cdef-examples.mac>`
-
 .. autospecmacro:: cdef-examples.mac

specdomain/src/specdomain/test/shutter.mac.rst

@@ -5 +5 @@
 ====================================================
 
-source code:  :download:`shutter.mac <shutter.mac>`
-
 .. caution:: This file is as-received.  
         No attempt to prepare it for ReST comments has been made.

specdomain/src/specdomain/test/test-battery.mac.rst

@@ -5 +5 @@
 ====================================================
 
-source code:  :download:`test-battery.mac <test-battery.mac>`
-
 .. autospecmacro:: test-battery.mac