Merge pull request #15231 from timhoffm/doc-rcparams-none

tacaswell · web-flow · commit 8ed827ea12d4 · 2019-09-10T15:08:21.000-04:00
DOC: Do not write default for non-existing rcParams
diff --git a/doc/sphinxext/custom_roles.py b/doc/sphinxext/custom_roles.py
@@ -4,8 +4,12 @@
 
 
 def rcparam_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
-    param = rcParamsDefault.get(text)
-    rendered = nodes.Text(f'rcParams["{text}"] = {param!r}')
+    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)
 
     source = inliner.document.attributes['source'].replace(sep, '/')
     rel_source = source.split('/doc/', 1)[1]
