Changeset 988

Timestamp:

Jul 2, 2012 12:10:31 PM (11 years ago)

Author:

jemian

Message:

refs #8, add variables to the index in two ways, add mac declarations to index in two ways

Location:

specdomain/trunk/src/specdomain

Files:

• sphinxcontrib/specdomain.py (modified) (3 diffs)
• test/index.rst (modified) (1 diff)
• test/test_doc.rst (modified) (1 diff)

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

@@ -134 +134 @@
         self.add_line(u'', '<autodoc>')
         self.add_line(u'.. index:: SPEC macro file; %s' % macrofile, '<autodoc>')
+        self.add_line(u'.. index:: !%s' % os.path.split(macrofile)[1], '<autodoc>')
         self.add_line(u'', '<autodoc>')
         line = 'source code:  :download:`%s <%s>`' % (macrofile, macrofile)
@@ -204 +205 @@
 
     def handle_signature(self, sig, signode):
+        '''return the name of this object from its signature'''
         # Must be able to match these (without preceding def or rdef)
         #     def macro_name
@@ -240 +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(), add_target_and_index(), and _get_index_text()
+    #       probably need to override handle_signature() and add_target_and_index()
+
+    def handle_signature(self, sig, signode):
+        '''return the name of this object from its signature'''
+        # TODO: Should it match a regular expression?
+        # TODO: What if global or local?  
+        return sig
+
+    def add_target_and_index(self, name, sig, signode):
+        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
+        text = u'! ' + sig      # TODO: How to use emphasized index entry in this context?
+        text = sig              # FIXME: temporary override
+        self.indexnode['entries'].append(('single', text, targetname, ''))
+        text = u'SPEC %s variable; %s' % (self.objtype, sig)
+        self.indexnode['entries'].append(('single', text, targetname, ''))
 
 class SpecXRefRole(XRefRole):

specdomain/trunk/src/specdomain/test/index.rst

@@ -14 +14 @@
    test_doc
 
+Example Python Source code documentation
+=============================================
+
+.. toctree::
+   :maxdepth: 2
+
+   python-example-source
+
 Indices and tables
 ==================

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

@@ -144 +144 @@
 
    *.mac
-   python-example-source