From f86b832efbc83b641bdad1db2628ccdc3b93b410 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Mon, 26 Aug 2019 09:42:35 -0400 Subject: [PATCH] Backport PR #15115: Doc: highlight rcparams --- .gitignore | 2 ++ doc/_static/mpl.css | 4 ++++ doc/sphinxext/custom_roles.py | 7 +++++-- 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index c74e7438a387..bb332f00e77b 100644 --- a/.gitignore +++ b/.gitignore @@ -54,6 +54,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 index ac4bde0486f9..8cdc2e5668d9 100644 --- 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 index 2232f1032424..88dddb6a2e4b 100644 --- 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)], []