Changeset 942 for specdomain/src/specdomain/sphinxcontrib/specdomain.py

Timestamp:

Jun 18, 2012 6:19:12 PM (10 years ago)

Author:

jemian

Message:

refs #8, apply ANL's short-form license, starting to understand how to get content added, try additional test case SPEC macro file

File:

• specdomain/src/specdomain/sphinxcontrib/specdomain.py (modified) (4 diffs)

specdomain/src/specdomain/sphinxcontrib/specdomain.py

@@ -4 +4 @@
     ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    SPEC domain.
-
-    :copyright: Copyright 2012 by Pete Jemian
-    :license: BSD, see LICENSE for details.
+    :synopsis: SPEC domain for Sphinx
+    
+    Automatically insert ReST-formatted extended comments 
+    from SPEC files for macro definitions and variable declarations into
+    the Sphinx doctree, thus avoiding duplication between docstrings and documentation
+    for those who like elaborate docstrings.
+
+    :copyright: Copyright 2012 by BCDA, Advanced Photon Source, Argonne National Laboratory
+    :license: ANL Open Source License, see LICENSE for details.
 """
 
@@ -25 +30 @@
 from sphinx.domains import Domain, ObjType, Index       #@UnusedImport
 from sphinx.util.compat import Directive                #@UnusedImport
-from sphinx.util.nodes import make_refnode
+from sphinx.util.nodes import make_refnode, nested_parse_with_titles
 from sphinx.util.docfields import Field, TypedField
 from sphinx.util.docstrings import prepare_docstring    #@UnusedImport
+
+from docutils.statemachine import ViewList, string2lines
+import sphinx.util.nodes
+
 
 match_all                   = r'.*'
@@ -199 +208 @@
         '''
         extended_comments_list = self.parse_macro_file(sig)
+        view = ViewList([u'TODO: recognize the ReST formatting in the following extended comment and it needs to be cleaned up'])
+        node = nodes.paragraph()
+        node.document = self.state.document
+        self.state.nested_parse(view, 0, signode)
+        # TODO: recognize the ReST formatting in the following extended comment and it needs to be cleaned up
         for extended_comment in extended_comments_list:
-            linenumber = -1                 # FIXME:
-            #for line in prepare_docstring(extended_comment, ignore=1):
-            #    self.result.append(self.indent + line, sig, linenumber)     # FIXME:
+            for line in string2lines(extended_comment):
+                view = ViewList([line])
+                nested_parse_with_titles(self.state, view, signode)
         return sig
     
@@ -227 +241 @@
             #e = node.end()
             #t = buf[s:e]
-            results.append(node.groups())            # TODO: can we get line number also?
+            results.append(node.groups()[0])            # TODO: can we get line number also?
         return results