Merge pull request #15863 from timhoffm/auto-backport-of-pr-15244-on-v3.1.x

tacaswell · web-flow · commit eacf90ef5d3b · 2019-12-08T15:37:44.000-05:00
Backport PR #15244 on branch v3.1.x: Change documentation format of rcParams defaults
diff --git a/doc/sphinxext/custom_roles.py b/doc/sphinxext/custom_roles.py
@@ -4,8 +4,7 @@
 
 
 def rcparam_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
-    param = rcParamsDefault.get(text)
-    rendered = nodes.Text(f'rcParams["{text}"] = {param!r}')
+    rendered = nodes.Text(f'rcParams["{text}"]')
 
     source = inliner.document.attributes['source'].replace(sep, '/')
     rel_source = source.split('/doc/', 1)[1]
@@ -16,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):
