Merge pull request #15115 from ImportanceOfBeingErnest/highlight-rcparams

tacaswell · web-flow · commit bedb4d9ce646 · 2019-08-26T09:42:35.000-04:00
DOC: highlight rcparams with defaults
diff --git a/.gitignore b/.gitignore
@@ -56,6 +56,8 @@ Thumbs.db
 ###################################
 lib/matplotlib/mpl-data/matplotlib.conf
 lib/matplotlib/mpl-data/matplotlibrc
+tutorials/intermediate/CL01.png
+tutorials/intermediate/CL02.png
 
 # Documentation generated files #
 #################################
diff --git a/doc/_static/mpl.css b/doc/_static/mpl.css
@@ -594,6 +594,10 @@ span.linkdescr {
     font-size: 90%;
 }
 
+.highlight span.c1 span.highlighted {
+    background-color: #fce5a6;
+}
+
 ul.search {
     margin: 10px 0 0 20px;
     padding: 0;
diff --git a/doc/sphinxext/custom_roles.py b/doc/sphinxext/custom_roles.py
@@ -1,16 +1,19 @@
 from docutils import nodes
 from os.path import sep
+from matplotlib import rcParamsDefault
 
 
 def rcparam_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
-    rendered = nodes.Text('rcParams["{}"]'.format(text))
+    param = rcParamsDefault.get(text)
+    rendered = nodes.Text(f'rcParams["{text}"] = {param!r}')
 
     source = inliner.document.attributes['source'].replace(sep, '/')
     rel_source = source.split('/doc/', 1)[1]
 
     levels = rel_source.count('/')
     refuri = ('../' * levels +
-              'tutorials/introductory/customizing.html#matplotlib-rcparams')
+              'tutorials/introductory/customizing.html' +
+              f"?highlight={text}#a-sample-matplotlibrc-file")
 
     ref = nodes.reference(rawtext, rendered, refuri=refuri)
     return [nodes.literal('', '', ref)], []
