File size: 9,118 Bytes
fe41391 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
"""
Add a ``figure-mpl`` directive that is a responsive version of ``figure``.
This implementation is very similar to ``.. figure::``, except it also allows a
``srcset=`` argument to be passed to the image tag, hence allowing responsive
resolution images.
There is no particular reason this could not be used standalone, but is meant
to be used with :doc:`/api/sphinxext_plot_directive_api`.
Note that the directory organization is a bit different than ``.. figure::``.
See the *FigureMpl* documentation below.
"""
from docutils import nodes
from docutils.parsers.rst import directives
from docutils.parsers.rst.directives.images import Figure, Image
import os
from os.path import relpath
from pathlib import PurePath, Path
import shutil
from sphinx.errors import ExtensionError
import matplotlib
class figmplnode(nodes.General, nodes.Element):
pass
class FigureMpl(Figure):
"""
Implements a directive to allow an optional hidpi image.
Meant to be used with the *plot_srcset* configuration option in conf.py,
and gets set in the TEMPLATE of plot_directive.py
e.g.::
.. figure-mpl:: plot_directive/some_plots-1.png
:alt: bar
:srcset: plot_directive/some_plots-1.png,
plot_directive/some_plots-1.2x.png 2.00x
:class: plot-directive
The resulting html (at ``some_plots.html``) is::
<img src="sphx_glr_bar_001_hidpi.png"
srcset="_images/some_plot-1.png,
_images/some_plots-1.2x.png 2.00x",
alt="bar"
class="plot_directive" />
Note that the handling of subdirectories is different than that used by the sphinx
figure directive::
.. figure-mpl:: plot_directive/nestedpage/index-1.png
:alt: bar
:srcset: plot_directive/nestedpage/index-1.png
plot_directive/nestedpage/index-1.2x.png 2.00x
:class: plot_directive
The resulting html (at ``nestedpage/index.html``)::
<img src="../_images/nestedpage-index-1.png"
srcset="../_images/nestedpage-index-1.png,
../_images/_images/nestedpage-index-1.2x.png 2.00x",
alt="bar"
class="sphx-glr-single-img" />
where the subdirectory is included in the image name for uniqueness.
"""
has_content = False
required_arguments = 1
optional_arguments = 2
final_argument_whitespace = False
option_spec = {
'alt': directives.unchanged,
'height': directives.length_or_unitless,
'width': directives.length_or_percentage_or_unitless,
'scale': directives.nonnegative_int,
'align': Image.align,
'class': directives.class_option,
'caption': directives.unchanged,
'srcset': directives.unchanged,
}
def run(self):
image_node = figmplnode()
imagenm = self.arguments[0]
image_node['alt'] = self.options.get('alt', '')
image_node['align'] = self.options.get('align', None)
image_node['class'] = self.options.get('class', None)
image_node['width'] = self.options.get('width', None)
image_node['height'] = self.options.get('height', None)
image_node['scale'] = self.options.get('scale', None)
image_node['caption'] = self.options.get('caption', None)
# we would like uri to be the highest dpi version so that
# latex etc will use that. But for now, lets just make
# imagenm... maybe pdf one day?
image_node['uri'] = imagenm
image_node['srcset'] = self.options.get('srcset', None)
return [image_node]
def _parse_srcsetNodes(st):
"""
parse srcset...
"""
entries = st.split(',')
srcset = {}
for entry in entries:
spl = entry.strip().split(' ')
if len(spl) == 1:
srcset[0] = spl[0]
elif len(spl) == 2:
mult = spl[1][:-1]
srcset[float(mult)] = spl[0]
else:
raise ExtensionError(f'srcset argument "{entry}" is invalid.')
return srcset
def _copy_images_figmpl(self, node):
# these will be the temporary place the plot-directive put the images eg:
# ../../../build/html/plot_directive/users/explain/artists/index-1.png
if node['srcset']:
srcset = _parse_srcsetNodes(node['srcset'])
else:
srcset = None
# the rst file's location: eg /Users/username/matplotlib/doc/users/explain/artists
docsource = PurePath(self.document['source']).parent
# get the relpath relative to root:
srctop = self.builder.srcdir
rel = relpath(docsource, srctop).replace('.', '').replace(os.sep, '-')
if len(rel):
rel += '-'
# eg: users/explain/artists
imagedir = PurePath(self.builder.outdir, self.builder.imagedir)
# eg: /Users/username/matplotlib/doc/build/html/_images/users/explain/artists
Path(imagedir).mkdir(parents=True, exist_ok=True)
# copy all the sources to the imagedir:
if srcset:
for src in srcset.values():
# the entries in srcset are relative to docsource's directory
abspath = PurePath(docsource, src)
name = rel + abspath.name
shutil.copyfile(abspath, imagedir / name)
else:
abspath = PurePath(docsource, node['uri'])
name = rel + abspath.name
shutil.copyfile(abspath, imagedir / name)
return imagedir, srcset, rel
def visit_figmpl_html(self, node):
imagedir, srcset, rel = _copy_images_figmpl(self, node)
# /doc/examples/subd/plot_1.rst
docsource = PurePath(self.document['source'])
# /doc/
# make sure to add the trailing slash:
srctop = PurePath(self.builder.srcdir, '')
# examples/subd/plot_1.rst
relsource = relpath(docsource, srctop)
# /doc/build/html
desttop = PurePath(self.builder.outdir, '')
# /doc/build/html/examples/subd
dest = desttop / relsource
# ../../_images/ for dirhtml and ../_images/ for html
imagerel = PurePath(relpath(imagedir, dest.parent)).as_posix()
if self.builder.name == "dirhtml":
imagerel = f'..{imagerel}'
# make uri also be relative...
nm = PurePath(node['uri'][1:]).name
uri = f'{imagerel}/{rel}{nm}'
# make srcset str. Need to change all the prefixes!
maxsrc = uri
srcsetst = ''
if srcset:
maxmult = -1
for mult, src in srcset.items():
nm = PurePath(src[1:]).name
# ../../_images/plot_1_2_0x.png
path = f'{imagerel}/{rel}{nm}'
srcsetst += path
if mult == 0:
srcsetst += ', '
else:
srcsetst += f' {mult:1.2f}x, '
if mult > maxmult:
maxmult = mult
maxsrc = path
# trim trailing comma and space...
srcsetst = srcsetst[:-2]
alt = node['alt']
if node['class'] is not None:
classst = ' '.join(node['class'])
classst = f'class="{classst}"'
else:
classst = ''
stylers = ['width', 'height', 'scale']
stylest = ''
for style in stylers:
if node[style]:
stylest += f'{style}: {node[style]};'
figalign = node['align'] if node['align'] else 'center'
# <figure class="align-default" id="id1">
# <a class="reference internal image-reference" href="_images/index-1.2x.png">
# <img alt="_images/index-1.2x.png" src="_images/index-1.2x.png" style="width: 53%;" />
# </a>
# <figcaption>
# <p><span class="caption-text">Figure caption is here....</span>
# <a class="headerlink" href="#id1" title="Permalink to this image">#</a></p>
# </figcaption>
# </figure>
img_block = (f'<img src="{uri}" style="{stylest}" srcset="{srcsetst}" '
f'alt="{alt}" {classst}/>')
html_block = f'<figure class="align-{figalign}">\n'
html_block += f' <a class="reference internal image-reference" href="{maxsrc}">\n'
html_block += f' {img_block}\n </a>\n'
if node['caption']:
html_block += ' <figcaption>\n'
html_block += f' <p><span class="caption-text">{node["caption"]}</span></p>\n'
html_block += ' </figcaption>\n'
html_block += '</figure>\n'
self.body.append(html_block)
def visit_figmpl_latex(self, node):
if node['srcset'] is not None:
imagedir, srcset = _copy_images_figmpl(self, node)
maxmult = -1
# choose the highest res version for latex:
maxmult = max(srcset, default=-1)
node['uri'] = PurePath(srcset[maxmult]).name
self.visit_figure(node)
def depart_figmpl_html(self, node):
pass
def depart_figmpl_latex(self, node):
self.depart_figure(node)
def figurempl_addnode(app):
app.add_node(figmplnode,
html=(visit_figmpl_html, depart_figmpl_html),
latex=(visit_figmpl_latex, depart_figmpl_latex))
def setup(app):
app.add_directive("figure-mpl", FigureMpl)
figurempl_addnode(app)
metadata = {'parallel_read_safe': True, 'parallel_write_safe': True,
'version': matplotlib.__version__}
return metadata
|