- adjust for foo=bar parameters

Author: zzzeek

sphinx_paramlinks/sphinx_paramlinks.py

@@ -48,9 +48,10 @@ def _cvt_param(name, line):
 
         def cvt(m):
             modifier, objname, paramname = m.group(1) or '', name, m.group(2)
+            refname = _refname_from_paramname(paramname)
             doc_idx.append(
-                ('single', '%s (%s parameter)' % (paramname, objname),
-                 '%s.params.%s' % (objname, paramname), '')
+                ('single', '%s (%s parameter)' % (refname, objname),
+                 '%s.params.%s' % (objname, refname), '')
             )
 
             return ":param %s_sphinx_paramlinks_%s.%s:" % (
@@ -61,6 +62,17 @@ def cvt(m):
         lines[:] = [_cvt_param(name, line) for line in lines]
 
 
+def _refname_from_paramname(paramname):
+    literal_match = re.match(r'^``(.+?)``$', paramname)
+    if literal_match:
+        paramname = literal_match.group(1)
+    refname = paramname
+    eq_match = re.match(r'(.+?)=.+$', refname)
+    if eq_match:
+        refname = eq_match.group(1)
+    return refname
+
+
 class LinkParams(Transform):
     # apply references targets and optional references
     # to nodes that contain our target text.
@@ -77,13 +89,7 @@ def apply(self):
             if text.startswith("_sphinx_paramlinks_"):
                 components = re.match(r'_sphinx_paramlinks_(.+)\.(.+)$', text)
                 location, paramname = components.group(1, 2)
-                literal_match = re.match(r'^``(.+?)``$', paramname)
-                if literal_match:
-                    paramname = literal_match.group(1)
-                refname = paramname
-                eq_match = re.match(r'(.+?)=.+$', refname)
-                if eq_match:
-                    refname = eq_match.group(1)
+                refname = _refname_from_paramname(paramname)
 
                 refid = "%s.params.%s" % (location, refname)
                 ref.parent.insert(