Link rcParams role to docs

timhoffm · timhoffm · commit c44e030ff315 · 2018-06-16T19:13:21.000+02:00
diff --git a/doc/_static/mpl.css b/doc/_static/mpl.css
@@ -23,6 +23,14 @@ a {
     text-decoration: none;
 }
 
+a.rcparams {
+    color: #814D00;
+}
+
+a:hover, a.rcparams:hover {
+    color: #2491CF;
+}
+
 div.highlight-python a {
     color: #CA7900;
 }
@@ -35,10 +43,6 @@ strong {
   font-weight: strong;
 }
 
-a:hover {
-    color: #2491CF;
-}
-
 pre {
     font-family:  Monaco, Menlo, Consolas, 'Courier New', monospace;
     font-size: 0.90em;
diff --git a/doc/sphinxext/custom_roles.py b/doc/sphinxext/custom_roles.py
@@ -3,7 +3,15 @@
 
 def rcparam_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
     rendered = nodes.Text('rcParams["{}"]'.format(text))
-    return [nodes.literal(rawtext, rendered)], []
+
+    rel_source = inliner.document.attributes['source'].split('/doc/', 1)[1]
+    levels = rel_source.count('/')
+    refuri = ('../' * levels +
+              'tutorials/introductory/customizing.html#matplotlib-rcparams')
+
+    ref = nodes.reference(rawtext, rendered, refuri=refuri,
+                          classes=['rcparams'])
+    return [nodes.literal('', '', ref)], []
 
 
 def setup(app):
