h# S r SSKJr SSKJr SSKJrJr SSKrSSK J
r
SSK J r J
r
SSKrSSKJr SSKr " S S
\R$ \R& 5 r " S S \5 rS
rS rS rS rS rS rS r S r g)a
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.
)nodes)
directives)FigureImageN)relpath)PurePathPath)ExtensionErrorc \ rS rSrSrg)
figmplnode N)__name__
__module__ __qualname____firstlineno____static_attributes__r W/var/www/html/env/lib/python3.13/site-packages/matplotlib/sphinxext/figmpl_directive.pyr r s r r c \ rS rSrSrSrSrSrSr\ R \ R \ R \ R \R \ R \ R \ R S.rS rSrg )
FigureMpl" a&
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::
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``)::
where the subdirectory is included in the image name for uniqueness.
F )altheightwidthscalealignclasscaptionsrcsetc 2 [ 5 nU R S nU R R SS5 US' U R R SS 5 US' U R R SS 5 US' U R R SS 5 US' U R R SS 5 US' U R R SS 5 US' U R R S S 5 US ' X!S
' U R R S S 5 US ' U/$ ) Nr r r r r r r r! urir" )r argumentsoptionsget)self
image_nodeimagenms r run
FigureMpl.run\ s \
..# LL , ,UB 7
5 "ll . .w =
7 "ll . .w =
7 "ll . .w =
7 #|| / /$ ?
8 "ll . .w =
7 $ 0 0D A
9 $5 #|| / /$ ?
8 |r r N)r r r r __doc__ has_contentrequired_argumentsoptional_argumentsfinal_argument_whitespacer unchangedlength_or_unitless length_or_percentage_or_unitlessnonnegative_intr r class_option option_specr, r r r r r r " ss (T K % ## //<<++(( '' && K r r c U R S5 n0 nU Hr nUR 5 R S5 n[ U5 S:X a
US US' M; [ U5 S:X a US SS nUS U[ U5 ' Me [ SU S 35 e U$ )
z
parse srcset...
, r r r Nzsrcset argument "z
" is invalid.)splitstriplenfloatr
)stentriesr" entrysplmults r _parse_srcsetNodesrF s s hhsmG
Fkkm!!#& s8q=AF1I
X]q6#2;D"%a&F5; #4UG=!IJ J Mr c US ( a [ US 5 nOS n[ U R S 5 R nU R R
n[
X45 R SS5 R [ R S5 n[ U5 ( a US-
n[ U R R U R R 5 n[ U5 R SSS9 U( aJ UR 5 H5 n[ X75 nXXR - n [" R$ " XU - 5 M7 O5[ X1S 5 nXXR - n [" R$ " XU - 5 XbU4$ ) Nr" source.r$ -T)parentsexist_okr% )rF r documentparentbuildersrcdirr replaceossepr? outdirimagedirr mkdirvaluesnameshutilcopyfile)
r) noder" docsourcesrctoprelrU srcabspathrX s
r _copy_images_figmplra s1 H~#DN3 x0188I \\
F
)
$
,
,S"
5
=
=bffc
JC
3xx s
++T\\-B-BCH N5 ==?C y.G %D OOG_ 5 # 95k2\\!D 1 S r c L [ X5 u p#n[ U R S 5 n[ U R R S5 n[ XV5 n[ U R R S5 nX- n [ [ X)R 5 5 R 5 n
U R R S:X a SU
3n
[ US SS 5 R n U
SU U 3n U n
SnU( ai SnUR 5 HN u nn[ USS 5 R n U
SU U 3nUU-
nUS :X a US
-
nO
US US S
3-
nUU: d MJ UnUn
MP US S nUS nUS b S R US 5 nSU S3nOSn/ SQnSnU H nUU ( d M UU SUU S3-
nM US ( a US OSnSU SU SU SU S U S 3 nS U S 3nUS U
S 3-
nUS!U S"3-
nUS# ( a US$-
nUS%US# S&3-
nUS'-
nUS(-
nU R R U5 g ))NrH r$ dirhtmlz..r% r /r< r z, r; z1.2fzx, r r zclass="")r r r z: ;r centerz
z
z6 z
z
z
)ra r rM rO rP r rT rN as_posixrX itemsjoinbodyappend)r) r[ rU r" r^ r\ r] relsourcedesttopdestimagerelnmr% maxsrcsrcsetstmaxmultrE r_ pathr classststylersstyleststylefigalign img_block
html_blocks r visit_figmpl_htmlr~ s / ;Hc x01I dll))2
.F *It||**B/G D ++67@@BH ||I%z?
$u+ab/ " ' 'B
JauRD
!C FH
ID##ab'"''B ZqbT*D HqyD aT{# ..g~ ( CR=
u+C G} ((4=)G9A& *GG ;; %4;-q1 1G !%W
tG}8H cU)G9Jxj I Ry,I(
$7JJ6(RVWWJD :..J I((
9$y/9J-XX
))
- JIIZ r c US b3 [ X5 u p#Sn[ USS9n[ X4 5 R US' U R U5 g )Nr" r< )defaultr% )ra maxr rX visit_figure)r) r[ rU r" ru s r visit_figmpl_latexr sN H~!.t:fb) v/44U dr c g Nr r) r[ s r depart_figmpl_htmlr
s r c & U R U5 g r )
depart_figurer s r depart_figmpl_latexr s t r c V U R [ [ [ 4[ [
4S9 g )N)htmllatex)add_noder r~ r r r )apps r figurempl_addnoder s( LL(*<=*,?@ Br c p U R S[ 5 [ U 5 SS[ R S.nU$ )Nz
figure-mplT)parallel_read_safeparallel_write_safeversion)
add_directiver r
matplotlib __version__)r metadatas r setupr s4 lI.c&*4%113H Or ) r. docutilsr docutils.parsers.rstr &docutils.parsers.rst.directives.imagesr r rR os.pathr pathlibr r rY
sphinx.errorsr
r GeneralElementr r rF ra r~ r r r r r r r r r sx
+ @ "
(
N N b$$!NR!j B r
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``)::
where the subdirectory is included in the image name for uniqueness.
F )altheightwidthscalealignclasscaptionsrcsetc 2 [ 5 nU R S nU R R SS5 US' U R R SS 5 US' U R R SS 5 US' U R R SS 5 US' U R R SS 5 US' U R R SS 5 US' U R R S S 5 US ' X!S
' U R R S S 5 US ' U/$ ) Nr r r r r r r r! urir" )r argumentsoptionsget)self
image_nodeimagenms r run
FigureMpl.run\ s \
..# LL , ,UB 7
5 "ll . .w =
7 "ll . .w =
7 "ll . .w =
7 #|| / /$ ?
8 "ll . .w =
7 $ 0 0D A
9 $5 #|| / /$ ?
8 |r r N)r r r r __doc__ has_contentrequired_argumentsoptional_argumentsfinal_argument_whitespacer unchangedlength_or_unitless length_or_percentage_or_unitlessnonnegative_intr r class_option option_specr, r r r r r r " ss (T K % ## //<<++(( '' && K r r c U R S5 n0 nU Hr nUR 5 R S5 n[ U5 S:X a
US US' M; [ U5 S:X a US SS nUS U[ U5 ' Me [ SU S 35 e U$ )
z
parse srcset...
, r r r Nzsrcset argument "z
" is invalid.)splitstriplenfloatr
)stentriesr" entrysplmults r _parse_srcsetNodesrF s s hhsmG
Fkkm!!#& s8q=AF1I
X]q6#2;D"%a&F5; #4UG=!IJ J Mr c US ( a [ US 5 nOS n[ U R S 5 R nU R R
n[
X45 R SS5 R [ R S5 n[ U5 ( a US-
n[ U R R U R R 5 n[ U5 R SSS9 U( aJ UR 5 H5 n[ X75 nXXR - n [" R$ " XU - 5 M7 O5[ X1S 5 nXXR - n [" R$ " XU - 5 XbU4$ ) Nr" source.r$ -T)parentsexist_okr% )rF r documentparentbuildersrcdirr replaceossepr? outdirimagedirr mkdirvaluesnameshutilcopyfile)
r) noder" docsourcesrctoprelrU srcabspathrX s
r _copy_images_figmplra s1 H~#DN3 x0188I \\
F
)
$
,
,S"
5
=
=bffc
JC
3xx s
++T\\-B-BCH N5 ==?C y.G %D OOG_ 5 # 95k2\\!D 1 S r c L [ X5 u p#n[ U R S 5 n[ U R R S5 n[ XV5 n[ U R R S5 nX- n [ [ X)R 5 5 R 5 n
U R R S:X a SU
3n
[ US SS 5 R n U
SU U 3n U n
SnU( ai SnUR 5 HN u nn[ USS 5 R n U
SU U 3nUU-
nUS :X a US
-
nO
US US S
3-
nUU: d MJ UnUn
MP US S nUS nUS b S R US 5 nSU S3nOSn/ SQnSnU H nUU ( d M UU SUU S3-
nM US ( a US OSnSU SU SU SU S U S 3 nS U S 3nUS U
S 3-
nUS!U S"3-
nUS# ( a US$-
nUS%US# S&3-
nUS'-
nUS(-
nU R R U5 g ))NrH r$ dirhtmlz..r% r /r< r z, r; z1.2fzx, r r zclass="")r r r z: ;r centerz