deploy: 4179fd4

config.html

@@ -32,7 +32,7 @@
         <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
 
 
-        <link rel="stylesheet" type="text/css" href="_static/sphinx_immaterial_theme.b6b76e63d02feb5bc.min.css?v=2a5fb5f3" />
+        <link rel="stylesheet" type="text/css" href="_static/sphinx_immaterial_theme.c9767e311a7fd7257.min.css?v=5bb8d638" />
         <link rel="stylesheet" type="text/css" href="_static/extra-css.css?v=79315577" />
     <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 
@@ -1894,15 +1894,15 @@ <h1 id="configuration">Configuration<a class="headerlink" href="#configuration"
 </code></pre></div>
 </div>
 </div>
-<p class="result"><a class="reference external" href="_images/config-7c6f1bb491ba4ce9.png"><img alt="A image generated by sphinx-social-cards" class="align-center" src="_images/config-7c6f1bb491ba4ce9.png" /></a></p>
+<p class="result"><a class="reference external" href="_images/config-00f04e8ed299c344.png"><img alt="A image generated by sphinx-social-cards" class="align-center" src="_images/config-00f04e8ed299c344.png" /></a></p>
 </div>
 </div>
 </div>
 </div></dd></dl>
 
 <dl class="py attribute objdesc">
 <dt class="sig sig-object highlight py" id="sphinx_social_cards.validators.Social_Cards.cards_layout_dir">
-<span class="sig-name descname"><span class="pre">cards_layout_dir</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.12)"><span class="pre">Path</span></a><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#sphinx_social_cards.validators.Social_Cards.cards_layout_dir" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">cards_layout_dir</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.12)"><span class="pre">Path</span></a><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#sphinx_social_cards.validators.Social_Cards.cards_layout_dir" title="Link to this definition">¶</a></dt>
 <dd><p>The list of paths (absolute or relative to conf.py) where the <a class="reference internal" href="#sphinx_social_cards.validators.Social_Cards.cards_layout" title="sphinx_social_cards.validators.Social_Cards.cards_layout (Python attribute) — The layout file's name used to generate the social cards. If using a custom-made layout (not a pre-made layout), then the layout file must be a YAML file. If the the cards_layout_dir is specified, then that path is searched for a matching layout before searching the default path of pre-made layouts."><code class="xref any py py-attr docutils literal notranslate"><span class="pre">cards_layout</span></code></a> is
 located. In the case of similarly named layout files, the order in this list takes
 precedence.</p>
@@ -1918,7 +1918,7 @@ <h1 id="configuration">Configuration<a class="headerlink" href="#configuration"
 
 <dl class="py attribute objdesc">
 <dt class="sig sig-object highlight py" id="sphinx_social_cards.validators.Social_Cards.cards_exclude">
-<span class="sig-name descname"><span class="pre">cards_exclude</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#sphinx_social_cards.validators.Social_Cards.cards_exclude" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">cards_exclude</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><span class="pre">Set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#sphinx_social_cards.validators.Social_Cards.cards_exclude" title="Link to this definition">¶</a></dt>
 <dd><p>This <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">list</span></code></a> can be used to exclude certain pages from generating social cards.
 Default is an empty <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">list</span></code></a>. Each item <strong>must</strong> be relative to the directory
 containing the conf.py file. <a class="reference external" href="https://docs.python.org/3/library/glob.html#module-glob" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">Glob</span> <span class="pre">patterns</span></code></a> are supported, and file
@@ -1947,7 +1947,7 @@ <h1 id="configuration">Configuration<a class="headerlink" href="#configuration"
 
 <dl class="py attribute objdesc">
 <dt class="sig sig-object highlight py" id="sphinx_social_cards.validators.Social_Cards.cards_include">
-<span class="sig-name descname"><span class="pre">cards_include</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#sphinx_social_cards.validators.Social_Cards.cards_include" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">cards_include</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><span class="pre">Set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#sphinx_social_cards.validators.Social_Cards.cards_include" title="Link to this definition">¶</a></dt>
 <dd><p>This <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">list</span></code></a> can be used to include certain pages from <a class="reference internal" href="#sphinx_social_cards.validators.Social_Cards.cards_exclude" title="sphinx_social_cards.validators.Social_Cards.cards_exclude (Python attribute) — This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">cards_exclude</span></code></a> <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">list</span></code></a>.
 Default is an empty <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">list</span></code></a>. Each item <strong>must</strong> be relative to the directory
 containing the conf.py file. <a class="reference external" href="https://docs.python.org/3/library/glob.html#module-glob" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">Glob</span> <span class="pre">patterns</span></code></a> are supported, and file
@@ -1967,7 +1967,7 @@ <h1 id="configuration">Configuration<a class="headerlink" href="#configuration"
 
 <dl class="py attribute objdesc">
 <dt class="sig sig-object highlight py" id="sphinx_social_cards.validators.Social_Cards.image_paths">
-<span class="sig-name descname"><span class="pre">image_paths</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.12)"><span class="pre">Path</span></a><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#sphinx_social_cards.validators.Social_Cards.image_paths" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">image_paths</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.12)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.12)"><span class="pre">Path</span></a><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#sphinx_social_cards.validators.Social_Cards.image_paths" title="Link to this definition">¶</a></dt>
 <dd><p>A list of directories that contain images to be used in the creation of social
 cards. By default, the path to the directory containing the conf.py file is
 automatically added to this list. Each entry in this list can be an absolute path or

directive.html

@@ -32,7 +32,7 @@
         <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
 
 
-        <link rel="stylesheet" type="text/css" href="_static/sphinx_immaterial_theme.b6b76e63d02feb5bc.min.css?v=2a5fb5f3" />
+        <link rel="stylesheet" type="text/css" href="_static/sphinx_immaterial_theme.c9767e311a7fd7257.min.css?v=5bb8d638" />
         <link rel="stylesheet" type="text/css" href="_static/extra-css.css?v=79315577" />
     <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 

genindex.html

@@ -32,7 +32,7 @@
         <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
 
 
-        <link rel="stylesheet" type="text/css" href="_static/sphinx_immaterial_theme.b6b76e63d02feb5bc.min.css?v=2a5fb5f3" />
+        <link rel="stylesheet" type="text/css" href="_static/sphinx_immaterial_theme.c9767e311a7fd7257.min.css?v=5bb8d638" />
         <link rel="stylesheet" type="text/css" href="_static/extra-css.css?v=79315577" />
     <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 

index.html

@@ -32,7 +32,7 @@
         <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
 
 
-        <link rel="stylesheet" type="text/css" href="_static/sphinx_immaterial_theme.b6b76e63d02feb5bc.min.css?v=2a5fb5f3" />
+        <link rel="stylesheet" type="text/css" href="_static/sphinx_immaterial_theme.c9767e311a7fd7257.min.css?v=5bb8d638" />
         <link rel="stylesheet" type="text/css" href="_static/extra-css.css?v=79315577" />
     <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 

layouts/background.html

@@ -32,7 +32,7 @@
         <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
 
 
-        <link rel="stylesheet" type="text/css" href="../_static/sphinx_immaterial_theme.b6b76e63d02feb5bc.min.css?v=2a5fb5f3" />
+        <link rel="stylesheet" type="text/css" href="../_static/sphinx_immaterial_theme.c9767e311a7fd7257.min.css?v=5bb8d638" />
         <link rel="stylesheet" type="text/css" href="../_static/extra-css.css?v=79315577" />
     <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 
@@ -721,7 +721,7 @@ <h1 id="layer-background-attribute">Layer Background attribute<a class="headerli
 
 <dl class="py attribute objdesc">
 <dt class="sig sig-object highlight py" id="sphinx_social_cards.validators.layers.Background.preserve_aspect">
-<span class="sig-name descname"><span class="pre">preserve_aspect</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="s"><span class="pre">'width'</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="s"><span class="pre">'height'</span></span></span><a class="headerlink" href="#sphinx_social_cards.validators.layers.Background.preserve_aspect" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">preserve_aspect</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'width'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'height'</span></span><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#sphinx_social_cards.validators.layers.Background.preserve_aspect" title="Link to this definition">¶</a></dt>
 <dd><p>If an image is used that doesn’t match the layer’s <a class="reference internal" href="index.html#sphinx_social_cards.validators.layout.Size" title="sphinx_social_cards.validators.layout.Size (Python class) — An attribute to describe a layer's or layout's size."><code class="xref any py py-class docutils literal notranslate"><span class="pre">size</span></code></a>, then the image
 will be resized accordingly. This option can be used to control which horizontal
 <a class="reference internal" href="index.html#sphinx_social_cards.validators.layout.Size.width" title="sphinx_social_cards.validators.layout.Size.width (Python attribute) — The width of the layer (relative to the offset). Defaults to 1200 pixels width."><code class="xref any py py-attr docutils literal notranslate"><span class="pre">width</span></code></a> or vertical <a class="reference internal" href="index.html#sphinx_social_cards.validators.layout.Size.height" title="sphinx_social_cards.validators.layout.Size.height (Python attribute) — The height of the layer (relative to the offset). Defaults to 630 pixels height."><code class="xref any py py-attr docutils literal notranslate"><span class="pre">height</span></code></a> or both (<code class="code highlight yaml docutils literal highlight-yaml"><span class="l l-Scalar l-Scalar-Plain">true</span></code>)