Link rcParams role to docs

timhoffm · timhoffm · commit 1af7495e8d2b · 2018-06-20T23:02:24.000+02:00
diff --git a/doc/_static/mpl.css b/doc/_static/mpl.css
@@ -23,6 +23,10 @@ a {
     text-decoration: none;
 }
 
+a:hover {
+    color: #2491CF;
+}
+
 div.highlight-python a {
     color: #CA7900;
 }
@@ -35,10 +39,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,14 @@
 
 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)
+    return [nodes.literal('', '', ref)], []
 
 
 def setup(app):

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,10 @@ a {`
`23`	`23`	`text-decoration: none;`
`24`	`24`	`}`
`25`	`25`
	`26`	`+a:hover {`
	`27`	`+ color: #2491CF;`
	`28`	`+}`
	`29`	`+`
`26`	`30`	`div.highlight-python a {`
`27`	`31`	`color: #CA7900;`
`28`	`32`	`}`
`@@ -35,10 +39,6 @@ strong {`
`35`	`39`	`font-weight: strong;`
`36`	`40`	`}`
`37`	`41`
`38`		`-a:hover {`
`39`		`- color: #2491CF;`
`40`		`-}`
`41`		`-`
`42`	`42`	`pre {`
`43`	`43`	`font-family: Monaco, Menlo, Consolas, 'Courier New', monospace;`
`44`	`44`	`font-size: 0.90em;`