Changeset 1012 for specdomain/trunk/src/specdomain/sphinxcontrib/specdomain.py

Timestamp:

Jul 13, 2012 6:22:00 PM (11 years ago)

Author:

jemian

Message:

refs #8, also index macro declarations under parent macro file, handle one pathological case in index

File:

• specdomain/trunk/src/specdomain/sphinxcontrib/specdomain.py (modified) (2 diffs)

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

@@ -239 +239 @@
             self.indexnode['entries'].append(('single', indextext, targetname, ''))
             self.indexnode['entries'].append(('single', sig, targetname, ''))
+            # TODO: what if there is more than one file, same name, different path?
+            filename = os.path.split(signode.document.current_source)[1]
+            if filename.endswith('.mac'):
+                # TODO: change the match pattern with an option
+                indextext = '%s; %s' % (filename, sig)
+                self.indexnode['entries'].append(('single', indextext, targetname, ''))
+
+    macro_types = {
+        'def':  'SPEC macro definition; %s',
+        'rdef': 'SPEC run-time macro definition; %s',
+        'cdef': 'SPEC chained macro definition; %s',
+    }
 
     def _get_index_text(self, name):
-        macro_types = {
-            'def':  'SPEC macro definition; %s',
-            'rdef': 'SPEC run-time macro definition; %s',
-            'cdef': 'SPEC chained macro definition; %s',
-        }
-        if self.objtype in macro_types:
-            return _(macro_types[self.objtype]) % name
+        if self.objtype in self.macro_types:
+            return _(self.macro_types[self.objtype]) % name
         else:
             return ''
@@ -298 +305 @@
 
     def add_target_and_index(self, name, sig, signode):
-        targetname = '%s-%s' % (self.objtype, name)
+        #text = u'! ' + sig      # TODO: How to use emphasized index entry in this context?
+        text = name.split()[0]   # when sig = "tth    #: scattering angle"
+        targetname = '%s-%s' % (self.objtype, text)
         signode['ids'].append(targetname)
         # 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)