Change documentation format of rcParams defaults

timhoffm · timhoffm · commit 56d17023553e · 2019-09-10T21:57:07.000+02:00
diff --git a/doc/sphinxext/custom_roles.py b/doc/sphinxext/custom_roles.py
@@ -4,12 +4,7 @@
 
 
 def rcparam_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
-    try:
-        default_str = f' = {rcParamsDefault[text]!r}'
-    except KeyError:
-        # handling of generic references such as rcParams["figure.subplot.*"]
-        default_str = ''
-    rendered = nodes.Text(f'rcParams["{text}"]' + default_str)
+    rendered = nodes.Text(f'rcParams["{text}"]')
 
     source = inliner.document.attributes['source'].replace(sep, '/')
     rel_source = source.split('/doc/', 1)[1]
@@ -20,7 +15,10 @@ def rcparam_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
               f"?highlight={text}#a-sample-matplotlibrc-file")
 
     ref = nodes.reference(rawtext, rendered, refuri=refuri)
-    return [nodes.literal('', '', ref)], []
+    node_list = [nodes.literal('', '', ref)]
+    if text in rcParamsDefault:
+        node_list.append(nodes.Text(f' (default: {rcParamsDefault[text]!r})'))
+    return node_list, []
 
 
 def setup(app):
