Configuration
-cards_layout_dir : list[str | Path]¶
+cards_layout_dir : List[str | Path]¶
The list of paths (absolute or relative to conf.py) where the cards_layout is
located. In the case of similarly named layout files, the order in this list takes
precedence.
@@ -1918,7 +1918,7 @@ Configuration
-cards_exclude : list[str] | set[str]¶
+cards_exclude : List[str] | Set[str]¶
This list can be used to exclude certain pages from generating social cards.
Default is an empty list. Each item must be relative to the directory
containing the conf.py file. Glob patterns are supported, and file
@@ -1947,7 +1947,7 @@
Configuration
-cards_include : list[str] | set[str]¶
+cards_include : List[str] | Set[str]¶
This list can be used to include certain pages from cards_exclude list.
Default is an empty list. Each item must be relative to the directory
containing the conf.py file. Glob patterns are supported, and file
@@ -1967,7 +1967,7 @@
Configuration
-image_paths : list[str | Path]¶
+image_paths : List[str | Path]¶
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
diff --git a/directive.html b/directive.html
index 5adfc62..81e3f0c 100644
--- a/directive.html
+++ b/directive.html
@@ -32,7 +32,7 @@
-
+
diff --git a/genindex.html b/genindex.html
index e6ec42b..d51d1c6 100644
--- a/genindex.html
+++ b/genindex.html
@@ -32,7 +32,7 @@
-
+
diff --git a/index.html b/index.html
index fc76d2f..754019a 100644
--- a/index.html
+++ b/index.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/background.html b/layouts/background.html
index 9f593ed..59cf5bb 100644
--- a/layouts/background.html
+++ b/layouts/background.html
@@ -32,7 +32,7 @@
-
+
@@ -721,7 +721,7 @@
Layer Background attribute
-preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/gradients/conical.html b/layouts/gradients/conical.html
index 2517d1b..ebe038c 100644
--- a/layouts/gradients/conical.html
+++ b/layouts/gradients/conical.html
@@ -32,7 +32,7 @@
-
+
@@ -782,7 +782,7 @@
Conical Gradients
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
diff --git a/layouts/gradients/index.html b/layouts/gradients/index.html
index 7c41bc1..5918643 100644
--- a/layouts/gradients/index.html
+++ b/layouts/gradients/index.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/linear.html b/layouts/gradients/linear.html
index 408c3e2..36f1f9f 100644
--- a/layouts/gradients/linear.html
+++ b/layouts/gradients/linear.html
@@ -32,7 +32,7 @@
-
+
@@ -790,7 +790,7 @@ Linear Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -826,7 +826,7 @@ Linear Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/gradients/presets.html b/layouts/gradients/presets.html
index 834630b..6623bb3 100644
--- a/layouts/gradients/presets.html
+++ b/layouts/gradients/presets.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/radial.html b/layouts/gradients/radial.html
index 0df1de0..195f73f 100644
--- a/layouts/gradients/radial.html
+++ b/layouts/gradients/radial.html
@@ -32,7 +32,7 @@
-
+
@@ -818,7 +818,7 @@ Radial Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -854,7 +854,7 @@ Radial Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/icon.html b/layouts/icon.html
index 291dadc..ef03306 100644
--- a/layouts/icon.html
+++ b/layouts/icon.html
@@ -32,7 +32,7 @@
-
+
@@ -739,7 +739,7 @@ Layer Icon Attribute
-
-preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/index.html b/layouts/index.html
index 9b15ae7..9cdd5d7 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -32,7 +32,7 @@
-
+
@@ -1222,7 +1222,7 @@
Layout Attributes
-
-layers : list[Layer]¶
+layers : List[Layer]¶
A YAML list of layers in the layout that define the entire
content of the layout.
Jinja Contexts
-
-theme : dict[str, Any]¶
+theme : Dict[str, Any]¶
A dict whose items correspond to the html_theme_options. This
dict is very dependent on the choice of sphinx theme and what it defines in its
theme.conf file.
@@ -1720,7 +1720,7 @@ Jinja Contextsdict whose items include the following:
-
-meta : dict[str, str]¶
+meta : Dict[str, str]¶
A dict whose items correspond to the page’s Metadata
(or meta element(s) created via the meta directive).
@@ -1748,7 +1748,7 @@ Jinja Contexts
-
-JinjaContexts.plugin : dict[str, Any]¶
+JinjaContexts.plugin : Dict[str, Any]¶
A dict whose items correspond to compatible plugins‘ contexts.
Layer Polygon attribute
-
-sides : int | list[Offset]¶
+sides : int | List[Offset]¶
The specification of the polygon’s sides. This can be an integer or
a YAML list of offsets.
diff --git a/layouts/shapes/rectangle.html b/layouts/shapes/rectangle.html
index dae7356..b0e5b91 100644
--- a/layouts/shapes/rectangle.html
+++ b/layouts/shapes/rectangle.html
@@ -32,7 +32,7 @@
-
+
@@ -820,7 +820,7 @@ Layer Rectangle attribute
-
-corners : list['top left' | 'top right' | 'bottom right' | 'bottom left']¶
+corners : List[Literal['top left', 'top right', 'bottom right', 'bottom left']]¶
This YAML list of strings specifies which corners are rounded. By default all
corners are rounded. The supported values are:
diff --git a/layouts/typography.html b/layouts/typography.html
index 9203e07..4779bbd 100644
--- a/layouts/typography.html
+++ b/layouts/typography.html
@@ -32,7 +32,7 @@
-
+
@@ -1003,7 +1003,7 @@ Layer Typography Attribute
-
-align : 'start top' | 'start center' | 'start bottom' | 'center top' | 'center' | 'center center' | 'center bottom' | 'end top' | 'end center' | 'end bottom'¶
+align : Literal['start top', 'start center', 'start bottom', 'center top', 'center', 'center center', 'center bottom', 'end top', 'end center', 'end bottom']¶
The alignment of text used. This is a string in which the space-separated words
respectively describe the horizontal and vertical alignment.
diff --git a/plugins/github.html b/plugins/github.html
index d1a8e68..e0dac65 100644
--- a/plugins/github.html
+++ b/plugins/github.html
@@ -32,7 +32,7 @@
-
+
@@ -1589,7 +1589,7 @@
-
-topics : list[str]¶
+topics : List[str]¶
The list of search topics designated for the repository.
-
-languages : dict[str, float]¶
+languages : Dict[str, float]¶
A dict of the used program languages in the repository. Each key is a
language’s name (eg. “Python”), and each value is the corresponding language’s
percent used (eg “97.8”).
@@ -1633,14 +1633,14 @@
-
-tags : list[str]¶
+tags : List[str]¶
A list of the repository’s tags (str). These values seem to be
ordered in recent descending to oldest tagged commits.
-
-contributors : list[Contributor]¶
+contributors : List[Contributor]¶
A list of the repository’s contributors.
@@ -1744,7 +1744,7 @@
-
-organizations : list[Organization]¶
+organizations : List[Organization]¶
A list of the Organizations to which the account belongs.
API
-
-add_jinja_context(app: Sphinx, jinja_ctx: Dict[str, Any])¶
+add_jinja_context(app: Sphinx, jinja_ctx: dict[str, Any])¶
Adds a dict to the builder environment key for plugin
jinja contexts.
-
-add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
+add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
Adds a str or Path of new layouts to the
cards_layout_dir list.
-
-add_images_dir(app: Sphinx, images_dir: str | Path)¶
+add_images_dir(app: Sphinx, images_dir: str | Path)¶
Adds a str or Path of new images to the
image_paths list.
diff --git a/py-modindex.html b/py-modindex.html
index 009ec89..4f1fb14 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -32,7 +32,7 @@
-
+
diff --git a/searchindex.js b/searchindex.js
index b202032..cf8ba76 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": 1, "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": [1, 3, 6, 8, 9, 16, 17], "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
The list of paths (absolute or relative to conf.py) where the cards_layout is
located. In the case of similarly named layout files, the order in this list takes
precedence.
Configuration
-cards_exclude : list[str] | set[str]¶
+cards_exclude : List[str] | Set[str]¶
This list can be used to exclude certain pages from generating social cards.
Default is an empty list. Each item must be relative to the directory
containing the conf.py file. Glob patterns are supported, and file
@@ -1947,7 +1947,7 @@
Configuration
-cards_include : list[str] | set[str]¶
+cards_include : List[str] | Set[str]¶
This list can be used to include certain pages from cards_exclude list.
Default is an empty list. Each item must be relative to the directory
containing the conf.py file. Glob patterns are supported, and file
@@ -1967,7 +1967,7 @@
Configuration
-image_paths : list[str | Path]¶
+image_paths : List[str | Path]¶
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
diff --git a/directive.html b/directive.html
index 5adfc62..81e3f0c 100644
--- a/directive.html
+++ b/directive.html
@@ -32,7 +32,7 @@
-
+
diff --git a/genindex.html b/genindex.html
index e6ec42b..d51d1c6 100644
--- a/genindex.html
+++ b/genindex.html
@@ -32,7 +32,7 @@
-
+
diff --git a/index.html b/index.html
index fc76d2f..754019a 100644
--- a/index.html
+++ b/index.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/background.html b/layouts/background.html
index 9f593ed..59cf5bb 100644
--- a/layouts/background.html
+++ b/layouts/background.html
@@ -32,7 +32,7 @@
-
+
@@ -721,7 +721,7 @@
Layer Background attribute
-preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/gradients/conical.html b/layouts/gradients/conical.html
index 2517d1b..ebe038c 100644
--- a/layouts/gradients/conical.html
+++ b/layouts/gradients/conical.html
@@ -32,7 +32,7 @@
-
+
@@ -782,7 +782,7 @@
Conical Gradients
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
diff --git a/layouts/gradients/index.html b/layouts/gradients/index.html
index 7c41bc1..5918643 100644
--- a/layouts/gradients/index.html
+++ b/layouts/gradients/index.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/linear.html b/layouts/gradients/linear.html
index 408c3e2..36f1f9f 100644
--- a/layouts/gradients/linear.html
+++ b/layouts/gradients/linear.html
@@ -32,7 +32,7 @@
-
+
@@ -790,7 +790,7 @@ Linear Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -826,7 +826,7 @@ Linear Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/gradients/presets.html b/layouts/gradients/presets.html
index 834630b..6623bb3 100644
--- a/layouts/gradients/presets.html
+++ b/layouts/gradients/presets.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/radial.html b/layouts/gradients/radial.html
index 0df1de0..195f73f 100644
--- a/layouts/gradients/radial.html
+++ b/layouts/gradients/radial.html
@@ -32,7 +32,7 @@
-
+
@@ -818,7 +818,7 @@ Radial Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -854,7 +854,7 @@ Radial Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/icon.html b/layouts/icon.html
index 291dadc..ef03306 100644
--- a/layouts/icon.html
+++ b/layouts/icon.html
@@ -32,7 +32,7 @@
-
+
@@ -739,7 +739,7 @@ Layer Icon Attribute
-
-preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/index.html b/layouts/index.html
index 9b15ae7..9cdd5d7 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -32,7 +32,7 @@
-
+
@@ -1222,7 +1222,7 @@
Layout Attributes
-
-layers : list[Layer]¶
+layers : List[Layer]¶
A YAML list of layers in the layout that define the entire
content of the layout.
Jinja Contexts
-
-theme : dict[str, Any]¶
+theme : Dict[str, Any]¶
A dict whose items correspond to the html_theme_options. This
dict is very dependent on the choice of sphinx theme and what it defines in its
theme.conf file.
@@ -1720,7 +1720,7 @@ Jinja Contextsdict whose items include the following:
-
-meta : dict[str, str]¶
+meta : Dict[str, str]¶
A dict whose items correspond to the page’s Metadata
(or meta element(s) created via the meta directive).
@@ -1748,7 +1748,7 @@ Jinja Contexts
-
-JinjaContexts.plugin : dict[str, Any]¶
+JinjaContexts.plugin : Dict[str, Any]¶
A dict whose items correspond to compatible plugins‘ contexts.
Layer Polygon attribute
-
-sides : int | list[Offset]¶
+sides : int | List[Offset]¶
The specification of the polygon’s sides. This can be an integer or
a YAML list of offsets.
diff --git a/layouts/shapes/rectangle.html b/layouts/shapes/rectangle.html
index dae7356..b0e5b91 100644
--- a/layouts/shapes/rectangle.html
+++ b/layouts/shapes/rectangle.html
@@ -32,7 +32,7 @@
-
+
@@ -820,7 +820,7 @@ Layer Rectangle attribute
-
-corners : list['top left' | 'top right' | 'bottom right' | 'bottom left']¶
+corners : List[Literal['top left', 'top right', 'bottom right', 'bottom left']]¶
This YAML list of strings specifies which corners are rounded. By default all
corners are rounded. The supported values are:
diff --git a/layouts/typography.html b/layouts/typography.html
index 9203e07..4779bbd 100644
--- a/layouts/typography.html
+++ b/layouts/typography.html
@@ -32,7 +32,7 @@
-
+
@@ -1003,7 +1003,7 @@ Layer Typography Attribute
-
-align : 'start top' | 'start center' | 'start bottom' | 'center top' | 'center' | 'center center' | 'center bottom' | 'end top' | 'end center' | 'end bottom'¶
+align : Literal['start top', 'start center', 'start bottom', 'center top', 'center', 'center center', 'center bottom', 'end top', 'end center', 'end bottom']¶
The alignment of text used. This is a string in which the space-separated words
respectively describe the horizontal and vertical alignment.
diff --git a/plugins/github.html b/plugins/github.html
index d1a8e68..e0dac65 100644
--- a/plugins/github.html
+++ b/plugins/github.html
@@ -32,7 +32,7 @@
-
+
@@ -1589,7 +1589,7 @@
-
-topics : list[str]¶
+topics : List[str]¶
The list of search topics designated for the repository.
-
-languages : dict[str, float]¶
+languages : Dict[str, float]¶
A dict of the used program languages in the repository. Each key is a
language’s name (eg. “Python”), and each value is the corresponding language’s
percent used (eg “97.8”).
@@ -1633,14 +1633,14 @@
-
-tags : list[str]¶
+tags : List[str]¶
A list of the repository’s tags (str). These values seem to be
ordered in recent descending to oldest tagged commits.
-
-contributors : list[Contributor]¶
+contributors : List[Contributor]¶
A list of the repository’s contributors.
@@ -1744,7 +1744,7 @@
-
-organizations : list[Organization]¶
+organizations : List[Organization]¶
A list of the Organizations to which the account belongs.
API
-
-add_jinja_context(app: Sphinx, jinja_ctx: Dict[str, Any])¶
+add_jinja_context(app: Sphinx, jinja_ctx: dict[str, Any])¶
Adds a dict to the builder environment key for plugin
jinja contexts.
-
-add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
+add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
Adds a str or Path of new layouts to the
cards_layout_dir list.
-
-add_images_dir(app: Sphinx, images_dir: str | Path)¶
+add_images_dir(app: Sphinx, images_dir: str | Path)¶
Adds a str or Path of new images to the
image_paths list.
diff --git a/py-modindex.html b/py-modindex.html
index 009ec89..4f1fb14 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -32,7 +32,7 @@
-
+
diff --git a/searchindex.js b/searchindex.js
index b202032..cf8ba76 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": 1, "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": [1, 3, 6, 8, 9, 16, 17], "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
This list can be used to exclude certain pages from generating social cards.
Default is an empty list. Each item must be relative to the directory
containing the conf.py file. Glob patterns are supported, and file
@@ -1947,7 +1947,7 @@
Configuration
-cards_include : list[str] | set[str]¶
+cards_include : List[str] | Set[str]¶
This list can be used to include certain pages from cards_exclude list.
Default is an empty list. Each item must be relative to the directory
containing the conf.py file. Glob patterns are supported, and file
@@ -1967,7 +1967,7 @@
Configuration
-image_paths : list[str | Path]¶
+image_paths : List[str | Path]¶
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
diff --git a/directive.html b/directive.html
index 5adfc62..81e3f0c 100644
--- a/directive.html
+++ b/directive.html
@@ -32,7 +32,7 @@
-
+
diff --git a/genindex.html b/genindex.html
index e6ec42b..d51d1c6 100644
--- a/genindex.html
+++ b/genindex.html
@@ -32,7 +32,7 @@
-
+
diff --git a/index.html b/index.html
index fc76d2f..754019a 100644
--- a/index.html
+++ b/index.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/background.html b/layouts/background.html
index 9f593ed..59cf5bb 100644
--- a/layouts/background.html
+++ b/layouts/background.html
@@ -32,7 +32,7 @@
-
+
@@ -721,7 +721,7 @@
Layer Background attribute
-preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/gradients/conical.html b/layouts/gradients/conical.html
index 2517d1b..ebe038c 100644
--- a/layouts/gradients/conical.html
+++ b/layouts/gradients/conical.html
@@ -32,7 +32,7 @@
-
+
@@ -782,7 +782,7 @@
Conical Gradients
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
diff --git a/layouts/gradients/index.html b/layouts/gradients/index.html
index 7c41bc1..5918643 100644
--- a/layouts/gradients/index.html
+++ b/layouts/gradients/index.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/linear.html b/layouts/gradients/linear.html
index 408c3e2..36f1f9f 100644
--- a/layouts/gradients/linear.html
+++ b/layouts/gradients/linear.html
@@ -32,7 +32,7 @@
-
+
@@ -790,7 +790,7 @@ Linear Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -826,7 +826,7 @@ Linear Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/gradients/presets.html b/layouts/gradients/presets.html
index 834630b..6623bb3 100644
--- a/layouts/gradients/presets.html
+++ b/layouts/gradients/presets.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/radial.html b/layouts/gradients/radial.html
index 0df1de0..195f73f 100644
--- a/layouts/gradients/radial.html
+++ b/layouts/gradients/radial.html
@@ -32,7 +32,7 @@
-
+
@@ -818,7 +818,7 @@ Radial Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -854,7 +854,7 @@ Radial Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/icon.html b/layouts/icon.html
index 291dadc..ef03306 100644
--- a/layouts/icon.html
+++ b/layouts/icon.html
@@ -32,7 +32,7 @@
-
+
@@ -739,7 +739,7 @@ Layer Icon Attribute
-
-preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/index.html b/layouts/index.html
index 9b15ae7..9cdd5d7 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -32,7 +32,7 @@
-
+
@@ -1222,7 +1222,7 @@
Layout Attributes
-
-layers : list[Layer]¶
+layers : List[Layer]¶
A YAML list of layers in the layout that define the entire
content of the layout.
Jinja Contexts
-
-theme : dict[str, Any]¶
+theme : Dict[str, Any]¶
A dict whose items correspond to the html_theme_options. This
dict is very dependent on the choice of sphinx theme and what it defines in its
theme.conf file.
@@ -1720,7 +1720,7 @@ Jinja Contextsdict whose items include the following:
-
-meta : dict[str, str]¶
+meta : Dict[str, str]¶
A dict whose items correspond to the page’s Metadata
(or meta element(s) created via the meta directive).
@@ -1748,7 +1748,7 @@ Jinja Contexts
-
-JinjaContexts.plugin : dict[str, Any]¶
+JinjaContexts.plugin : Dict[str, Any]¶
A dict whose items correspond to compatible plugins‘ contexts.
Layer Polygon attribute
-
-sides : int | list[Offset]¶
+sides : int | List[Offset]¶
The specification of the polygon’s sides. This can be an integer or
a YAML list of offsets.
diff --git a/layouts/shapes/rectangle.html b/layouts/shapes/rectangle.html
index dae7356..b0e5b91 100644
--- a/layouts/shapes/rectangle.html
+++ b/layouts/shapes/rectangle.html
@@ -32,7 +32,7 @@
-
+
@@ -820,7 +820,7 @@ Layer Rectangle attribute
-
-corners : list['top left' | 'top right' | 'bottom right' | 'bottom left']¶
+corners : List[Literal['top left', 'top right', 'bottom right', 'bottom left']]¶
This YAML list of strings specifies which corners are rounded. By default all
corners are rounded. The supported values are:
diff --git a/layouts/typography.html b/layouts/typography.html
index 9203e07..4779bbd 100644
--- a/layouts/typography.html
+++ b/layouts/typography.html
@@ -32,7 +32,7 @@
-
+
@@ -1003,7 +1003,7 @@ Layer Typography Attribute
-
-align : 'start top' | 'start center' | 'start bottom' | 'center top' | 'center' | 'center center' | 'center bottom' | 'end top' | 'end center' | 'end bottom'¶
+align : Literal['start top', 'start center', 'start bottom', 'center top', 'center', 'center center', 'center bottom', 'end top', 'end center', 'end bottom']¶
The alignment of text used. This is a string in which the space-separated words
respectively describe the horizontal and vertical alignment.
diff --git a/plugins/github.html b/plugins/github.html
index d1a8e68..e0dac65 100644
--- a/plugins/github.html
+++ b/plugins/github.html
@@ -32,7 +32,7 @@
-
+
@@ -1589,7 +1589,7 @@
-
-topics : list[str]¶
+topics : List[str]¶
The list of search topics designated for the repository.
-
-languages : dict[str, float]¶
+languages : Dict[str, float]¶
A dict of the used program languages in the repository. Each key is a
language’s name (eg. “Python”), and each value is the corresponding language’s
percent used (eg “97.8”).
@@ -1633,14 +1633,14 @@
-
-tags : list[str]¶
+tags : List[str]¶
A list of the repository’s tags (str). These values seem to be
ordered in recent descending to oldest tagged commits.
-
-contributors : list[Contributor]¶
+contributors : List[Contributor]¶
A list of the repository’s contributors.
@@ -1744,7 +1744,7 @@
-
-organizations : list[Organization]¶
+organizations : List[Organization]¶
A list of the Organizations to which the account belongs.
API
-
-add_jinja_context(app: Sphinx, jinja_ctx: Dict[str, Any])¶
+add_jinja_context(app: Sphinx, jinja_ctx: dict[str, Any])¶
Adds a dict to the builder environment key for plugin
jinja contexts.
-
-add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
+add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
Adds a str or Path of new layouts to the
cards_layout_dir list.
-
-add_images_dir(app: Sphinx, images_dir: str | Path)¶
+add_images_dir(app: Sphinx, images_dir: str | Path)¶
Adds a str or Path of new images to the
image_paths list.
diff --git a/py-modindex.html b/py-modindex.html
index 009ec89..4f1fb14 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -32,7 +32,7 @@
-
+
diff --git a/searchindex.js b/searchindex.js
index b202032..cf8ba76 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": 1, "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": [1, 3, 6, 8, 9, 16, 17], "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
This list can be used to include certain pages from cards_exclude list.
Default is an empty list. Each item must be relative to the directory
containing the conf.py file. Glob patterns are supported, and file
@@ -1967,7 +1967,7 @@
Configuration
-image_paths : list[str | Path]¶
+image_paths : List[str | Path]¶
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
diff --git a/directive.html b/directive.html
index 5adfc62..81e3f0c 100644
--- a/directive.html
+++ b/directive.html
@@ -32,7 +32,7 @@
-
+
diff --git a/genindex.html b/genindex.html
index e6ec42b..d51d1c6 100644
--- a/genindex.html
+++ b/genindex.html
@@ -32,7 +32,7 @@
-
+
diff --git a/index.html b/index.html
index fc76d2f..754019a 100644
--- a/index.html
+++ b/index.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/background.html b/layouts/background.html
index 9f593ed..59cf5bb 100644
--- a/layouts/background.html
+++ b/layouts/background.html
@@ -32,7 +32,7 @@
-
+
@@ -721,7 +721,7 @@
Layer Background attribute
-preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/gradients/conical.html b/layouts/gradients/conical.html
index 2517d1b..ebe038c 100644
--- a/layouts/gradients/conical.html
+++ b/layouts/gradients/conical.html
@@ -32,7 +32,7 @@
-
+
@@ -782,7 +782,7 @@
Conical Gradients
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
diff --git a/layouts/gradients/index.html b/layouts/gradients/index.html
index 7c41bc1..5918643 100644
--- a/layouts/gradients/index.html
+++ b/layouts/gradients/index.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/linear.html b/layouts/gradients/linear.html
index 408c3e2..36f1f9f 100644
--- a/layouts/gradients/linear.html
+++ b/layouts/gradients/linear.html
@@ -32,7 +32,7 @@
-
+
@@ -790,7 +790,7 @@ Linear Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -826,7 +826,7 @@ Linear Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/gradients/presets.html b/layouts/gradients/presets.html
index 834630b..6623bb3 100644
--- a/layouts/gradients/presets.html
+++ b/layouts/gradients/presets.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/radial.html b/layouts/gradients/radial.html
index 0df1de0..195f73f 100644
--- a/layouts/gradients/radial.html
+++ b/layouts/gradients/radial.html
@@ -32,7 +32,7 @@
-
+
@@ -818,7 +818,7 @@ Radial Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -854,7 +854,7 @@ Radial Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/icon.html b/layouts/icon.html
index 291dadc..ef03306 100644
--- a/layouts/icon.html
+++ b/layouts/icon.html
@@ -32,7 +32,7 @@
-
+
@@ -739,7 +739,7 @@ Layer Icon Attribute
-
-preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/index.html b/layouts/index.html
index 9b15ae7..9cdd5d7 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -32,7 +32,7 @@
-
+
@@ -1222,7 +1222,7 @@
Layout Attributes
-
-layers : list[Layer]¶
+layers : List[Layer]¶
A YAML list of layers in the layout that define the entire
content of the layout.
Jinja Contexts
-
-theme : dict[str, Any]¶
+theme : Dict[str, Any]¶
A dict whose items correspond to the html_theme_options. This
dict is very dependent on the choice of sphinx theme and what it defines in its
theme.conf file.
@@ -1720,7 +1720,7 @@ Jinja Contextsdict whose items include the following:
-
-meta : dict[str, str]¶
+meta : Dict[str, str]¶
A dict whose items correspond to the page’s Metadata
(or meta element(s) created via the meta directive).
@@ -1748,7 +1748,7 @@ Jinja Contexts
-
-JinjaContexts.plugin : dict[str, Any]¶
+JinjaContexts.plugin : Dict[str, Any]¶
A dict whose items correspond to compatible plugins‘ contexts.
Layer Polygon attribute
-
-sides : int | list[Offset]¶
+sides : int | List[Offset]¶
The specification of the polygon’s sides. This can be an integer or
a YAML list of offsets.
diff --git a/layouts/shapes/rectangle.html b/layouts/shapes/rectangle.html
index dae7356..b0e5b91 100644
--- a/layouts/shapes/rectangle.html
+++ b/layouts/shapes/rectangle.html
@@ -32,7 +32,7 @@
-
+
@@ -820,7 +820,7 @@ Layer Rectangle attribute
-
-corners : list['top left' | 'top right' | 'bottom right' | 'bottom left']¶
+corners : List[Literal['top left', 'top right', 'bottom right', 'bottom left']]¶
This YAML list of strings specifies which corners are rounded. By default all
corners are rounded. The supported values are:
diff --git a/layouts/typography.html b/layouts/typography.html
index 9203e07..4779bbd 100644
--- a/layouts/typography.html
+++ b/layouts/typography.html
@@ -32,7 +32,7 @@
-
+
@@ -1003,7 +1003,7 @@ Layer Typography Attribute
-
-align : 'start top' | 'start center' | 'start bottom' | 'center top' | 'center' | 'center center' | 'center bottom' | 'end top' | 'end center' | 'end bottom'¶
+align : Literal['start top', 'start center', 'start bottom', 'center top', 'center', 'center center', 'center bottom', 'end top', 'end center', 'end bottom']¶
The alignment of text used. This is a string in which the space-separated words
respectively describe the horizontal and vertical alignment.
diff --git a/plugins/github.html b/plugins/github.html
index d1a8e68..e0dac65 100644
--- a/plugins/github.html
+++ b/plugins/github.html
@@ -32,7 +32,7 @@
-
+
@@ -1589,7 +1589,7 @@
-
-topics : list[str]¶
+topics : List[str]¶
The list of search topics designated for the repository.
-
-languages : dict[str, float]¶
+languages : Dict[str, float]¶
A dict of the used program languages in the repository. Each key is a
language’s name (eg. “Python”), and each value is the corresponding language’s
percent used (eg “97.8”).
@@ -1633,14 +1633,14 @@
-
-tags : list[str]¶
+tags : List[str]¶
A list of the repository’s tags (str). These values seem to be
ordered in recent descending to oldest tagged commits.
-
-contributors : list[Contributor]¶
+contributors : List[Contributor]¶
A list of the repository’s contributors.
@@ -1744,7 +1744,7 @@
-
-organizations : list[Organization]¶
+organizations : List[Organization]¶
A list of the Organizations to which the account belongs.
API
-
-add_jinja_context(app: Sphinx, jinja_ctx: Dict[str, Any])¶
+add_jinja_context(app: Sphinx, jinja_ctx: dict[str, Any])¶
Adds a dict to the builder environment key for plugin
jinja contexts.
-
-add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
+add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
Adds a str or Path of new layouts to the
cards_layout_dir list.
-
-add_images_dir(app: Sphinx, images_dir: str | Path)¶
+add_images_dir(app: Sphinx, images_dir: str | Path)¶
Adds a str or Path of new images to the
image_paths list.
diff --git a/py-modindex.html b/py-modindex.html
index 009ec89..4f1fb14 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -32,7 +32,7 @@
-
+
diff --git a/searchindex.js b/searchindex.js
index b202032..cf8ba76 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": 1, "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": [1, 3, 6, 8, 9, 16, 17], "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
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 diff --git a/directive.html b/directive.html index 5adfc62..81e3f0c 100644 --- a/directive.html +++ b/directive.html @@ -32,7 +32,7 @@ - + diff --git a/genindex.html b/genindex.html index e6ec42b..d51d1c6 100644 --- a/genindex.html +++ b/genindex.html @@ -32,7 +32,7 @@ - + diff --git a/index.html b/index.html index fc76d2f..754019a 100644 --- a/index.html +++ b/index.html @@ -32,7 +32,7 @@ - + diff --git a/layouts/background.html b/layouts/background.html index 9f593ed..59cf5bb 100644 --- a/layouts/background.html +++ b/layouts/background.html @@ -32,7 +32,7 @@ - + @@ -721,7 +721,7 @@
Layer Background attribute
-preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/gradients/conical.html b/layouts/gradients/conical.html
index 2517d1b..ebe038c 100644
--- a/layouts/gradients/conical.html
+++ b/layouts/gradients/conical.html
@@ -32,7 +32,7 @@
-
+
@@ -782,7 +782,7 @@
Conical Gradients
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
diff --git a/layouts/gradients/index.html b/layouts/gradients/index.html
index 7c41bc1..5918643 100644
--- a/layouts/gradients/index.html
+++ b/layouts/gradients/index.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/linear.html b/layouts/gradients/linear.html
index 408c3e2..36f1f9f 100644
--- a/layouts/gradients/linear.html
+++ b/layouts/gradients/linear.html
@@ -32,7 +32,7 @@
-
+
@@ -790,7 +790,7 @@ Linear Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -826,7 +826,7 @@ Linear Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/gradients/presets.html b/layouts/gradients/presets.html
index 834630b..6623bb3 100644
--- a/layouts/gradients/presets.html
+++ b/layouts/gradients/presets.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/radial.html b/layouts/gradients/radial.html
index 0df1de0..195f73f 100644
--- a/layouts/gradients/radial.html
+++ b/layouts/gradients/radial.html
@@ -32,7 +32,7 @@
-
+
@@ -818,7 +818,7 @@ Radial Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -854,7 +854,7 @@ Radial Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/icon.html b/layouts/icon.html
index 291dadc..ef03306 100644
--- a/layouts/icon.html
+++ b/layouts/icon.html
@@ -32,7 +32,7 @@
-
+
@@ -739,7 +739,7 @@ Layer Icon Attribute
-
-preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/index.html b/layouts/index.html
index 9b15ae7..9cdd5d7 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -32,7 +32,7 @@
-
+
@@ -1222,7 +1222,7 @@
Layout Attributes
-
-layers : list[Layer]¶
+layers : List[Layer]¶
A YAML list of layers in the layout that define the entire
content of the layout.
Jinja Contexts
-
-theme : dict[str, Any]¶
+theme : Dict[str, Any]¶
A dict whose items correspond to the html_theme_options. This
dict is very dependent on the choice of sphinx theme and what it defines in its
theme.conf file.
@@ -1720,7 +1720,7 @@ Jinja Contextsdict whose items include the following:
-
-meta : dict[str, str]¶
+meta : Dict[str, str]¶
A dict whose items correspond to the page’s Metadata
(or meta element(s) created via the meta directive).
@@ -1748,7 +1748,7 @@ Jinja Contexts
-
-JinjaContexts.plugin : dict[str, Any]¶
+JinjaContexts.plugin : Dict[str, Any]¶
A dict whose items correspond to compatible plugins‘ contexts.
Layer Polygon attribute
-
-sides : int | list[Offset]¶
+sides : int | List[Offset]¶
The specification of the polygon’s sides. This can be an integer or
a YAML list of offsets.
diff --git a/layouts/shapes/rectangle.html b/layouts/shapes/rectangle.html
index dae7356..b0e5b91 100644
--- a/layouts/shapes/rectangle.html
+++ b/layouts/shapes/rectangle.html
@@ -32,7 +32,7 @@
-
+
@@ -820,7 +820,7 @@ Layer Rectangle attribute
-
-corners : list['top left' | 'top right' | 'bottom right' | 'bottom left']¶
+corners : List[Literal['top left', 'top right', 'bottom right', 'bottom left']]¶
This YAML list of strings specifies which corners are rounded. By default all
corners are rounded. The supported values are:
diff --git a/layouts/typography.html b/layouts/typography.html
index 9203e07..4779bbd 100644
--- a/layouts/typography.html
+++ b/layouts/typography.html
@@ -32,7 +32,7 @@
-
+
@@ -1003,7 +1003,7 @@ Layer Typography Attribute
-
-align : 'start top' | 'start center' | 'start bottom' | 'center top' | 'center' | 'center center' | 'center bottom' | 'end top' | 'end center' | 'end bottom'¶
+align : Literal['start top', 'start center', 'start bottom', 'center top', 'center', 'center center', 'center bottom', 'end top', 'end center', 'end bottom']¶
The alignment of text used. This is a string in which the space-separated words
respectively describe the horizontal and vertical alignment.
diff --git a/plugins/github.html b/plugins/github.html
index d1a8e68..e0dac65 100644
--- a/plugins/github.html
+++ b/plugins/github.html
@@ -32,7 +32,7 @@
-
+
@@ -1589,7 +1589,7 @@
-
-topics : list[str]¶
+topics : List[str]¶
The list of search topics designated for the repository.
-
-languages : dict[str, float]¶
+languages : Dict[str, float]¶
A dict of the used program languages in the repository. Each key is a
language’s name (eg. “Python”), and each value is the corresponding language’s
percent used (eg “97.8”).
@@ -1633,14 +1633,14 @@
-
-tags : list[str]¶
+tags : List[str]¶
A list of the repository’s tags (str). These values seem to be
ordered in recent descending to oldest tagged commits.
-
-contributors : list[Contributor]¶
+contributors : List[Contributor]¶
A list of the repository’s contributors.
@@ -1744,7 +1744,7 @@
-
-organizations : list[Organization]¶
+organizations : List[Organization]¶
A list of the Organizations to which the account belongs.
API
-
-add_jinja_context(app: Sphinx, jinja_ctx: Dict[str, Any])¶
+add_jinja_context(app: Sphinx, jinja_ctx: dict[str, Any])¶
Adds a dict to the builder environment key for plugin
jinja contexts.
-
-add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
+add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
Adds a str or Path of new layouts to the
cards_layout_dir list.
-
-add_images_dir(app: Sphinx, images_dir: str | Path)¶
+add_images_dir(app: Sphinx, images_dir: str | Path)¶
Adds a str or Path of new images to the
image_paths list.
diff --git a/py-modindex.html b/py-modindex.html
index 009ec89..4f1fb14 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -32,7 +32,7 @@
-
+
diff --git a/searchindex.js b/searchindex.js
index b202032..cf8ba76 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": 1, "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": [1, 3, 6, 8, 9, 16, 17], "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/gradients/conical.html b/layouts/gradients/conical.html
index 2517d1b..ebe038c 100644
--- a/layouts/gradients/conical.html
+++ b/layouts/gradients/conical.html
@@ -32,7 +32,7 @@
-
+
@@ -782,7 +782,7 @@
Conical Gradients
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
diff --git a/layouts/gradients/index.html b/layouts/gradients/index.html
index 7c41bc1..5918643 100644
--- a/layouts/gradients/index.html
+++ b/layouts/gradients/index.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/linear.html b/layouts/gradients/linear.html
index 408c3e2..36f1f9f 100644
--- a/layouts/gradients/linear.html
+++ b/layouts/gradients/linear.html
@@ -32,7 +32,7 @@
-
+
@@ -790,7 +790,7 @@ Linear Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -826,7 +826,7 @@ Linear Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/gradients/presets.html b/layouts/gradients/presets.html
index 834630b..6623bb3 100644
--- a/layouts/gradients/presets.html
+++ b/layouts/gradients/presets.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/radial.html b/layouts/gradients/radial.html
index 0df1de0..195f73f 100644
--- a/layouts/gradients/radial.html
+++ b/layouts/gradients/radial.html
@@ -32,7 +32,7 @@
-
+
@@ -818,7 +818,7 @@ Radial Gradients
-
-colors : dict[float, Color]¶
+colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
@@ -854,7 +854,7 @@ Radial Gradients
-
-spread : 'pad' | 'reflect' | 'repeat'¶
+spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified
area. By default this is set to pad.
diff --git a/layouts/icon.html b/layouts/icon.html
index 291dadc..ef03306 100644
--- a/layouts/icon.html
+++ b/layouts/icon.html
@@ -32,7 +32,7 @@
-
+
@@ -739,7 +739,7 @@ Layer Icon Attribute
-
-preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶
If an image is used that doesn’t match the layer’s size, then the image
will be resized accordingly. This option can be used to control which horizontal
width or vertical height or both (true)
diff --git a/layouts/index.html b/layouts/index.html
index 9b15ae7..9cdd5d7 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -32,7 +32,7 @@
-
+
@@ -1222,7 +1222,7 @@
Layout Attributes
-
-layers : list[Layer]¶
+layers : List[Layer]¶
A YAML list of layers in the layout that define the entire
content of the layout.
Jinja Contexts
-
-theme : dict[str, Any]¶
+theme : Dict[str, Any]¶
A dict whose items correspond to the html_theme_options. This
dict is very dependent on the choice of sphinx theme and what it defines in its
theme.conf file.
@@ -1720,7 +1720,7 @@ Jinja Contextsdict whose items include the following:
-
-meta : dict[str, str]¶
+meta : Dict[str, str]¶
A dict whose items correspond to the page’s Metadata
(or meta element(s) created via the meta directive).
@@ -1748,7 +1748,7 @@ Jinja Contexts
-
-JinjaContexts.plugin : dict[str, Any]¶
+JinjaContexts.plugin : Dict[str, Any]¶
A dict whose items correspond to compatible plugins‘ contexts.
Layer Polygon attribute
-
-sides : int | list[Offset]¶
+sides : int | List[Offset]¶
The specification of the polygon’s sides. This can be an integer or
a YAML list of offsets.
diff --git a/layouts/shapes/rectangle.html b/layouts/shapes/rectangle.html
index dae7356..b0e5b91 100644
--- a/layouts/shapes/rectangle.html
+++ b/layouts/shapes/rectangle.html
@@ -32,7 +32,7 @@
-
+
@@ -820,7 +820,7 @@ Layer Rectangle attribute
-
-corners : list['top left' | 'top right' | 'bottom right' | 'bottom left']¶
+corners : List[Literal['top left', 'top right', 'bottom right', 'bottom left']]¶
This YAML list of strings specifies which corners are rounded. By default all
corners are rounded. The supported values are:
diff --git a/layouts/typography.html b/layouts/typography.html
index 9203e07..4779bbd 100644
--- a/layouts/typography.html
+++ b/layouts/typography.html
@@ -32,7 +32,7 @@
-
+
@@ -1003,7 +1003,7 @@ Layer Typography Attribute
-
-align : 'start top' | 'start center' | 'start bottom' | 'center top' | 'center' | 'center center' | 'center bottom' | 'end top' | 'end center' | 'end bottom'¶
+align : Literal['start top', 'start center', 'start bottom', 'center top', 'center', 'center center', 'center bottom', 'end top', 'end center', 'end bottom']¶
The alignment of text used. This is a string in which the space-separated words
respectively describe the horizontal and vertical alignment.
diff --git a/plugins/github.html b/plugins/github.html
index d1a8e68..e0dac65 100644
--- a/plugins/github.html
+++ b/plugins/github.html
@@ -32,7 +32,7 @@
-
+
@@ -1589,7 +1589,7 @@
-
-topics : list[str]¶
+topics : List[str]¶
The list of search topics designated for the repository.
-
-languages : dict[str, float]¶
+languages : Dict[str, float]¶
A dict of the used program languages in the repository. Each key is a
language’s name (eg. “Python”), and each value is the corresponding language’s
percent used (eg “97.8”).
@@ -1633,14 +1633,14 @@
-
-tags : list[str]¶
+tags : List[str]¶
A list of the repository’s tags (str). These values seem to be
ordered in recent descending to oldest tagged commits.
-
-contributors : list[Contributor]¶
+contributors : List[Contributor]¶
A list of the repository’s contributors.
@@ -1744,7 +1744,7 @@
-
-organizations : list[Organization]¶
+organizations : List[Organization]¶
A list of the Organizations to which the account belongs.
API
-
-add_jinja_context(app: Sphinx, jinja_ctx: Dict[str, Any])¶
+add_jinja_context(app: Sphinx, jinja_ctx: dict[str, Any])¶
Adds a dict to the builder environment key for plugin
jinja contexts.
-
-add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
+add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
Adds a str or Path of new layouts to the
cards_layout_dir list.
-
-add_images_dir(app: Sphinx, images_dir: str | Path)¶
+add_images_dir(app: Sphinx, images_dir: str | Path)¶
Adds a str or Path of new images to the
image_paths list.
diff --git a/py-modindex.html b/py-modindex.html
index 009ec89..4f1fb14 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -32,7 +32,7 @@
-
+
diff --git a/searchindex.js b/searchindex.js
index b202032..cf8ba76 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": 1, "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/)."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": [1, 3, 6, 8, 9, 16, 17], "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", "sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}})
\ No newline at end of file
A mapping of colors to their corresponding positions in the gradient.
Each item in this mapping is composed of key: value pairs in which:
-
diff --git a/layouts/gradients/index.html b/layouts/gradients/index.html
index 7c41bc1..5918643 100644
--- a/layouts/gradients/index.html
+++ b/layouts/gradients/index.html
@@ -32,7 +32,7 @@
-
+
diff --git a/layouts/gradients/linear.html b/layouts/gradients/linear.html
index 408c3e2..36f1f9f 100644
--- a/layouts/gradients/linear.html
+++ b/layouts/gradients/linear.html
@@ -32,7 +32,7 @@
-
+
@@ -790,7 +790,7 @@
- -colors : dict[float, Color]¶ +colors : Dict[float, Color]¶
A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of
key: valuepairs in which:-
@@ -826,7 +826,7 @@
- -spread : 'pad' | 'reflect' | 'repeat'¶ +spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified area. By default this is set to
pad.diff --git a/layouts/gradients/presets.html b/layouts/gradients/presets.html index 834630b..6623bb3 100644 --- a/layouts/gradients/presets.html +++ b/layouts/gradients/presets.html @@ -32,7 +32,7 @@ - + diff --git a/layouts/gradients/radial.html b/layouts/gradients/radial.html index 0df1de0..195f73f 100644 --- a/layouts/gradients/radial.html +++ b/layouts/gradients/radial.html @@ -32,7 +32,7 @@ - + @@ -818,7 +818,7 @@Radial Gradients
- -colors : dict[float, Color]¶
+colors : Dict[float, Color]¶A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of
key: valuepairs in which:-
@@ -854,7 +854,7 @@
- -spread : 'pad' | 'reflect' | 'repeat'¶ +spread : Literal['pad', 'reflect', 'repeat']¶
This attribute controls the colors’ behavior outside the gradient’s specified area. By default this is set to
pad.diff --git a/layouts/icon.html b/layouts/icon.html index 291dadc..ef03306 100644 --- a/layouts/icon.html +++ b/layouts/icon.html @@ -32,7 +32,7 @@ - + @@ -739,7 +739,7 @@Layer Icon Attribute
- -preserve_aspect : bool | 'width' | 'height'¶
+preserve_aspect : bool | Literal['width', 'height']¶If an image is used that doesn’t match the layer’s
size, then the image will be resized accordingly. This option can be used to control which horizontalwidthor verticalheightor both (true) diff --git a/layouts/index.html b/layouts/index.html index 9b15ae7..9cdd5d7 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -32,7 +32,7 @@ - + @@ -1222,7 +1222,7 @@Layout Attributes
- -layers : list[Layer]¶
+layers : List[Layer]¶A YAML list of layers in the layout that define the entire content of the layout.
Jinja Contexts
- -theme : dict[str, Any]¶
+theme : Dict[str, Any]¶A
@@ -1720,7 +1720,7 @@dictwhose items correspond to thehtml_theme_options. Thisdictis very dependent on the choice of sphinx theme and what it defines in itstheme.conffile.Jinja Contexts
dictwhose items include the following:- -meta : dict[str, str]¶ +meta : Dict[str, str]¶
A
dictwhose items correspond to the page’s Metadata (or meta element(s) created via the meta directive).
Jinja Contexts
- -JinjaContexts.plugin : dict[str, Any]¶
+JinjaContexts.plugin : Dict[str, Any]¶A
dictwhose items correspond to compatible plugins‘ contexts.Layer Polygon attribute
- -sides : int | list[Offset]¶ +sides : int | List[Offset]¶
The specification of the polygon’s sides. This can be an integer or a YAML list of
offsets.-
diff --git a/layouts/shapes/rectangle.html b/layouts/shapes/rectangle.html
index dae7356..b0e5b91 100644
--- a/layouts/shapes/rectangle.html
+++ b/layouts/shapes/rectangle.html
@@ -32,7 +32,7 @@
-
+
@@ -820,7 +820,7 @@
- -corners : list['top left' | 'top right' | 'bottom right' | 'bottom left']¶ +corners : List[Literal['top left', 'top right', 'bottom right', 'bottom left']]¶
This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:
diff --git a/layouts/typography.html b/layouts/typography.html index 9203e07..4779bbd 100644 --- a/layouts/typography.html +++ b/layouts/typography.html @@ -32,7 +32,7 @@ - + @@ -1003,7 +1003,7 @@
Layer Typography Attribute
- -align : 'start top' | 'start center' | 'start bottom' | 'center top' | 'center' | 'center center' | 'center bottom' | 'end top' | 'end center' | 'end bottom'¶
+align : Literal['start top', 'start center', 'start bottom', 'center top', 'center', 'center center', 'center bottom', 'end top', 'end center', 'end bottom']¶The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment.
diff --git a/plugins/github.html b/plugins/github.html index d1a8e68..e0dac65 100644 --- a/plugins/github.html +++ b/plugins/github.html @@ -32,7 +32,7 @@ - + @@ -1589,7 +1589,7 @@
- -topics : list[str]¶
+topics : List[str]¶The
listof search topics designated for the repository.- -languages : dict[str, float]¶
+languages : Dict[str, float]¶A
@@ -1633,14 +1633,14 @@dictof the used program languages in the repository. Each key is a language’s name (eg. “Python”), and each value is the corresponding language’s percent used (eg “97.8”).- -tags : list[str]¶
+tags : List[str]¶A
listof the repository’s tags (str). These values seem to be ordered in recent descending to oldest tagged commits.- -contributors : list[Contributor]¶ +contributors : List[Contributor]¶
A
listof the repository’scontributors.
- -organizations : list[Organization]¶
+organizations : List[Organization]¶A
listof theOrganizations to which the account belongs.API
- -add_jinja_context(app: Sphinx, jinja_ctx: Dict[str, Any])¶ +add_jinja_context(app: Sphinx, jinja_ctx: dict[str, Any])¶
Adds a
dictto the builder environment key forpluginjinja contexts.
- -add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶ +add_layouts_dir(app: Sphinx, layouts_dir: str | Path)¶
Adds a
strorPathof new layouts to thecards_layout_dirlist.
- -add_images_dir(app: Sphinx, images_dir: str | Path)¶ +add_images_dir(app: Sphinx, images_dir: str | Path)¶
Adds a
strorPathof new images to theimage_pathslist.
.github.io/ )."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": 1, "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", " sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API Reference": [[19, "module-sphinx_social_cards.plugins"]], "AboveTheSky (116)": [[7, "abovethesky-116"]], "Added Context": [[18, "added-context"]], "Added Layouts": [[18, "added-layouts"]], "Adding Context": [[19, "adding-context"]], "Adding Images": [[19, "adding-images"]], "Adding Layouts": [[19, "adding-layouts"]], "AfricanField (131)": [[7, "africanfield-131"]], "AlchemistLab (87)": [[7, "alchemistlab-87"]], "Alignment Options": [[17, "id4"]], "AmourAmour (97)": [[7, "amouramour-97"]], "AmyCrisp (14)": [[7, "amycrisp-14"]], "AngelCare (158)": [[7, "angelcare-158"]], "AquaGuidance (150)": [[7, "aquaguidance-150"]], "AquaSplash (70)": [[7, "aquasplash-70"]], "Area of polygons are clamped": [[15, null]], "Area of polygons are restricted": [[15, null]], "AwesomePine (42)": [[7, "awesomepine-42"]], "Basic Shapes": [[14, "basic-shapes"]], "BigMango (95)": [[7, "bigmango-95"]], "BlackSea (153)": [[7, "blacksea-153"]], "Blessing (31)": [[7, "blessing-31"]], "Blog front matter": [[0, "blog-front-matter"]], "BurningSpring (65)": [[7, "burningspring-65"]], "Caching Fonts": [[0, null]], "Card Layout Options": [[10, "card-layout-options"]], "Caution": [[17, null]], "Changing the description": [[0, "changing-the-description"]], "Changing the icon": [[0, "changing-the-icon"]], "Changing the icon may not be consistent for different layouts.": [[0, null]], "Changing the title": [[0, "changing-the-title"]], "CheerfulCaramel (122)": [[7, "cheerfulcaramel-122"]], "ChildCare (112)": [[7, "childcare-112"]], "Choosing a color": [[0, "choosing-a-color"]], "Choosing the font": [[0, "choosing-the-font"]], "CleanMirror (75)": [[7, "cleanmirror-75"]], "CloudyApple (94)": [[7, "cloudyapple-94"]], "CloudyKnoxville (18)": [[7, "cloudyknoxville-18"]], "CochitiLake (78)": [[7, "cochitilake-78"]], "ColdEvening (77)": [[7, "coldevening-77"]], "ColorfulPeach (126)": [[7, "colorfulpeach-126"]], "ConfidentCloud (107)": [[7, "confidentcloud-107"]], "Configuration": [[0, "configuration"], [18, "configuration"]], "Conical Gradients": [[4, "conical-gradients"]], "Cookiecutter Available": [[19, null]], "Creating a Plugin": [[19, "creating-a-plugin"]], "CrystalRiver (159)": [[7, "crystalriver-159"]], "Crystalline (104)": [[7, "crystalline-104"]], "Customized Layouts": [[10, "customized-layouts"]], "Debugging Layouts": [[0, "debugging-layouts"]], "DeepBlue (16)": [[7, "deepblue-16"]], "DeepRelief (166)": [[7, "deeprelief-166"]], "DenseWater (118)": [[7, "densewater-118"]], "Dependencies": [[2, "dependencies"], [18, "dependencies"]], "DesertHump (82)": [[7, "deserthump-82"]], "Directives": [[1, "directives"]], "DirtyBeauty (57)": [[7, "dirtybeauty-57"]], "DustyGrass (11)": [[7, "dustygrass-11"]], "Enabling": [[18, "enabling"]], "Error": [[11, null], [11, null], [15, null], [16, null]], "Escaping Jinja Syntax": [[11, "escaping-jinja-syntax"]], "EternalConstance (91)": [[7, "eternalconstance-91"]], "EverlastingSky (29)": [[7, "everlastingsky-29"]], "FabledSunset (179)": [[7, "fabledsunset-179"]], "FarawayRiver (86)": [[7, "farawayriver-86"]], "FebruaryInk (51)": [[7, "februaryink-51"]], "FlyHigh (47)": [[7, "flyhigh-47"]], "FlyingLemon (113)": [[7, "flyinglemon-113"]], "Font specification": [[17, "font-specification"]], "ForestInei (143)": [[7, "forestinei-143"]], "FreshMilk (49)": [[7, "freshmilk-49"]], "FreshOasis (163)": [[7, "freshoasis-163"]], "FrozenBerry (110)": [[7, "frozenberry-110"]], "FrozenDreams (9)": [[7, "frozendreams-9"]], "FrozenHeat (177)": [[7, "frozenheat-177"]], "FruitBlend (137)": [[7, "fruitblend-137"]], "Full blog layout syntax": [[0, null]], "Full default layout syntax": [[0, null]], "Full default/accent layout syntax": [[0, null]], "Full default/inverted layout syntax": [[0, null]], "Full default/variant layout syntax": [[0, null]], "Full opengraph layout syntax": [[0, null]], "GagarinView (178)": [[7, "gagarinview-178"]], "GentleCare (127)": [[7, "gentlecare-127"]], "GlassWater (134)": [[7, "glasswater-134"]], "Gradient Colors": [[5, "gradient-colors"]], "Gradient color specification": [[0, "gradient-color-specification"]], "Gradients are implemented as aliases of color": [[5, null]], "GrassShampoo (154)": [[7, "grassshampoo-154"]], "GreatWhale (58)": [[7, "greatwhale-58"]], "GrownEarly (54)": [[7, "grownearly-54"]], "HappyAcid (41)": [[7, "happyacid-41"]], "HappyFisher (30)": [[7, "happyfisher-30"]], "HappyMemories (102)": [[7, "happymemories-102"]], "HappyUnicorn (129)": [[7, "happyunicorn-129"]], "HealthyWater (96)": [[7, "healthywater-96"]], "HeavenPeach (68)": [[7, "heavenpeach-68"]], "HeavyRain (13)": [[7, "heavyrain-13"]], "HiddenJaguar (115)": [[7, "hiddenjaguar-115"]], "HighFlight (139)": [[7, "highflight-139"]], "Hint": [[3, null], [9, null], [9, null]], "Implementation details about the cached information": [[18, null]], "Important": [[1, null], [11, null], [13, null], [17, null]], "Inheritance Tutorial": [[11, "inheritance-tutorial"]], "Inheriting Layouts": [[11, "inheriting-layouts"]], "Installing": [[2, "installing"]], "ItmeoBranding (35)": [[7, "itmeobranding-35"]], "JapanBlush (92)": [[7, "japanblush-92"]], "Jinja Contexts": [[11, "jinja-contexts"]], "JuicyCake (146)": [[7, "juicycake-146"]], "JuicyPeach (4)": [[7, "juicypeach-4"]], "JungleDay (83)": [[7, "jungleday-83"]], "KindSteel (52)": [[7, "kindsteel-52"]], "LadogaBottom (33)": [[7, "ladogabottom-33"]], "LadyLips (6)": [[7, "ladylips-6"]], "LandingAircraft (155)": [[7, "landingaircraft-155"]], "Layer Background attribute": [[3, "layer-background-attribute"]], "Layer Ellipse attribute": [[13, "layer-ellipse-attribute"]], "Layer Icon Attribute": [[9, "layer-icon-attribute"]], "Layer Mask attribute": [[12, "layer-mask-attribute"]], "Layer Polygon attribute": [[15, "layer-polygon-attribute"]], "Layer Rectangle attribute": [[16, "layer-rectangle-attribute"]], "Layer Typography Attribute": [[17, "layer-typography-attribute"]], "Layer of a Layout": [[11, "layer-of-a-layout"]], "Layout Attributes": [[10, "layout-attributes"]], "Layouts are Jinja Templates": [[11, "layouts-are-jinja-templates"]], "LeCocktail (108)": [[7, "lecocktail-108"]], "LemonGate (34)": [[7, "lemongate-34"]], "LightBlue (170)": [[7, "lightblue-170"]], "LilyMeadow (172)": [[7, "lilymeadow-172"]], "Linear Gradients": [[6, "linear-gradients"]], "LoveKiss (73)": [[7, "lovekiss-73"]], "MagicLake (124)": [[7, "magiclake-124"]], "MagicRay (175)": [[7, "magicray-175"]], "MalibuBeach (19)": [[7, "malibubeach-19"]], "MarbleWall (121)": [[7, "marblewall-121"]], "MarsParty (90)": [[7, "marsparty-90"]], "MeanFruit (15)": [[7, "meanfruit-15"]], "Meaning of a mask layer\u2019s Size and Offset": [[12, null]], "Metadata": [[0, "metadata"]], "MidnightBloom (103)": [[7, "midnightbloom-103"]], "MillenniumPine (138)": [[7, "millenniumpine-138"]], "MindCrawl (171)": [[7, "mindcrawl-171"]], "Missing file extensions": [[3, null], [9, null]], "MixedHopes (46)": [[7, "mixedhopes-46"]], "MoleHall (140)": [[7, "molehall-140"]], "MorningSalad (165)": [[7, "morningsalad-165"]], "MorpheusDen (22)": [[7, "morpheusden-22"]], "MountainRock (81)": [[7, "mountainrock-81"]], "NearMoon (24)": [[7, "nearmoon-24"]], "Nega (117)": [[7, "nega-117"]], "NewLife (20)": [[7, "newlife-20"]], "NewRetrowave (114)": [[7, "newretrowave-114"]], "NewYork (43)": [[7, "newyork-43"]], "NightCall (168)": [[7, "nightcall-168"]], "NightFade (2)": [[7, "nightfade-2"]], "NightParty (66)": [[7, "nightparty-66"]], "NightSky (123)": [[7, "nightsky-123"]], "Non-English languages": [[0, "non-english-languages"]], "NorseBeauty (149)": [[7, "norsebeauty-149"]], "NorthMiracle (136)": [[7, "northmiracle-136"]], "Note": [[0, null], [0, null], [0, null], [2, null], [9, null], [11, null], [11, null], [15, null], [17, null]], "OctoberSilence (85)": [[7, "octobersilence-85"]], "OldHat (37)": [[7, "oldhat-37"]], "OrangeJuice (133)": [[7, "orangejuice-133"]], "OverSun (88)": [[7, "oversun-88"]], "PaloAlto (101)": [[7, "paloalto-101"]], "PartyBliss (106)": [[7, "partybliss-106"]], "PassionateBed (80)": [[7, "passionatebed-80"]], "PerfectBlue (180)": [[7, "perfectblue-180"]], "PerfectWhite (162)": [[7, "perfectwhite-162"]], "PhoenixStart (84)": [[7, "phoenixstart-84"]], "PlumBath (128)": [[7, "plumbath-128"]], "PlumPlate (28)": [[7, "plumplate-28"]], "PoliteRumors (60)": [[7, "politerumors-60"]], "Positioning Attributes": [[10, "positioning-attributes"]], "PremiumDark (76)": [[7, "premiumdark-76"]], "PremiumWhite (89)": [[7, "premiumwhite-89"]], "Preset Gradients": [[7, "preset-gradients"]], "PurpleDivision (69)": [[7, "purpledivision-69"]], "Radial Gradients": [[8, "radial-gradients"]], "RainyAshville (8)": [[7, "rainyashville-8"]], "RareWind (23)": [[7, "rarewind-23"]], "RedSalvation (64)": [[7, "redsalvation-64"]], "Referencing Jinja Contexts": [[11, "referencing-jinja-contexts"]], "RichMetal (145)": [[7, "richmetal-145"]], "RipeMalinka (17)": [[7, "ripemalinka-17"]], "RiskyConcrete (98)": [[7, "riskyconcrete-98"]], "RiverCity (109)": [[7, "rivercity-109"]], "RoyalGarden (144)": [[7, "royalgarden-144"]], "SaintPetersburg (26)": [[7, "saintpetersburg-26"]], "SaltMountain (161)": [[7, "saltmountain-161"]], "SandStrike (148)": [[7, "sandstrike-148"]], "SeaLord (152)": [[7, "sealord-152"]], "SeaStrike (167)": [[7, "seastrike-167"]], "Seashore (120)": [[7, "seashore-120"]], "Seealso": [[1, null], [3, null], [5, null], [5, null], [5, null], [5, null], [5, null], [5, null], [7, null], [9, null], [10, null], [10, null], [11, null], [11, null], [13, null], [14, null], [15, null], [15, null], [16, null], [17, null], [17, null], [17, null], [17, null]], "Setting the date dynamically": [[0, null]], "ShadyWater (56)": [[7, "shadywater-56"]], "SharpBlues (55)": [[7, "sharpblues-55"]], "SharpeyeEagle (32)": [[7, "sharpeyeeagle-32"]], "ShyRainbow (44)": [[7, "shyrainbow-44"]], "SkyGlider (67)": [[7, "skyglider-67"]], "SleeplessNight (157)": [[7, "sleeplessnight-157"]], "SmartIndigo (147)": [[7, "smartindigo-147"]], "SmilingRain (93)": [[7, "smilingrain-93"]], "SnowAgain (50)": [[7, "snowagain-50"]], "Social Cards": [[2, "module-sphinx_social_cards"]], "SoftCherish (63)": [[7, "softcherish-63"]], "SoftGrass (53)": [[7, "softgrass-53"]], "SoftLipstick (160)": [[7, "softlipstick-160"]], "Solid color syntax": [[0, "solid-color-syntax"]], "Solid colors do not need the yaml filter": [[11, null]], "SolidStone (132)": [[7, "solidstone-132"]], "SpaceShift (142)": [[7, "spaceshift-142"]], "SpikyNaga (72)": [[7, "spikynaga-72"]], "SpringWarmth (3)": [[7, "springwarmth-3"]], "StarWine (38)": [[7, "starwine-38"]], "StrictNovember (164)": [[7, "strictnovember-164"]], "StrongBliss (48)": [[7, "strongbliss-48"]], "StrongStick (99)": [[7, "strongstick-99"]], "SugarLollipop (173)": [[7, "sugarlollipop-173"]], "SummerGames (79)": [[7, "summergames-79"]], "SunVeggie (151)": [[7, "sunveggie-151"]], "SunnyMorning (7)": [[7, "sunnymorning-7"]], "SupremeSky (169)": [[7, "supremesky-169"]], "SweetDessert (174)": [[7, "sweetdessert-174"]], "SweetPeriod (61)": [[7, "sweetperiod-61"]], "TeenNotebook (59)": [[7, "teennotebook-59"]], "TeenParty (176)": [[7, "teenparty-176"]], "TemptingAzure (12)": [[7, "temptingazure-12"]], "The yaml Jinja filter (for referencing color values)": [[11, "the-yaml-jinja-filter-for-referencing-color-values"]], "There is no inline style parsing.": [[17, null]], "Tip": [[16, null], [18, null]], "TrueSunset (21)": [[7, "truesunset-21"]], "Typography Line specification": [[17, "typography-line-specification"]], "Usage": [[2, "usage"]], "Useless Options (demonstration purposes only)": [[1, "non-op-dir-opts"]], "User List Sub-Contexts": [[18, "user-list-sub-contexts"]], "Using Jinja Syntax within the Layout": [[11, "using-jinja-syntax-within-the-layout"]], "Using spread: repeat as a proof": [[8, null]], "Variable and icon fonts are not supported": [[0, null]], "ViciousStance (100)": [[7, "viciousstance-100"]], "WarmFlame (1)": [[7, "warmflame-1"]], "Warning": [[5, null], [8, null], [11, null], [19, null], [19, null], [19, null]], "Weights over styles": [[0, "weights-over-styles"]], "What about the other colors and stuff?": [[11, null]], "WideMatrix (62)": [[7, "widematrix-62"]], "WildApple (25)": [[7, "wildapple-25"]], "WinterNeva (10)": [[7, "winterneva-10"]], "WitchDance (156)": [[7, "witchdance-156"]], "YoungGrass (125)": [[7, "younggrass-125"]], "YoungPassion (5)": [[7, "youngpassion-5"]], "ZeusMiracle (36)": [[7, "zeusmiracle-36"]], "differences between Jinja syntax": [[11, "id6"]], "owner Sub-Context": [[18, "owner-sub-context"]], "repo Sub-Context": [[18, "repo-sub-context"]], "sphinx-social-cards Plugins": [[19, "sphinx-social-cards-plugins"]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github"]], "spread not applicable to conical gradients": [[4, null]]}, "docurls": ["config.html", "directive.html", "index.html", "layouts/background.html", "layouts/gradients/conical.html", "layouts/gradients/index.html", "layouts/gradients/linear.html", "layouts/gradients/presets.html", "layouts/gradients/radial.html", "layouts/icon.html", "layouts/index.html", "layouts/layers.html", "layouts/mask.html", "layouts/shapes/ellipse.html", "layouts/shapes/index.html", "layouts/shapes/polygon.html", "layouts/shapes/rectangle.html", "layouts/typography.html", "plugins/github.html", "plugins/index.html"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "indexentries": {":conf-caption: (directive option)": [[1, "directive-option-social-card-conf-caption", false]], ":dry-run: (directive option)": [[1, "directive-option-social-card-dry-run", false]], ":hide-conf: (directive option)": [[1, "directive-option-social-card-hide-conf", false]], ":hide-layout: (directive option)": [[1, "directive-option-social-card-hide-layout", false]], ":hide-meta-data: (directive option)": [[1, "directive-option-social-card-hide-meta-data", false]], ":layout-caption: (directive option)": [[1, "directive-option-social-card-layout-caption", false]], ":meta-data-caption: (directive option)": [[1, "directive-option-social-card-meta-data-caption", false]], ":meta-data: (directive option)": [[1, "directive-option-social-card-meta-data", false]], "accent (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.accent", false]], "add_images_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_images_dir", false]], "add_jinja_context() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_jinja_context", false]], "add_layouts_dir() (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.add_layouts_dir", false]], "align (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.align", false]], "amount (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.amount", false]], "angle (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.angle", false]], "arc (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Arc", false]], "arc (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.arc", false]], "author": [[0, "meta-field-author", false]], "author (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.author", false]], "avatar (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.avatar", false]], "avatar (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.avatar", false]], "avatar (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.avatar", false]], "background (class in sphinx_social_cards.validators.layers)": [[3, "sphinx_social_cards.validators.layers.Background", false]], "background (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.background", false]], "background_color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_color", false]], "background_image (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.background_image", false]], "bio (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.bio", false]], "blog (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.blog", false]], "border (class in sphinx_social_cards.validators.layers)": [[14, "sphinx_social_cards.validators.layers.Border", false]], "border (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border", false]], "border (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.border", false]], "border (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.border", false]], "border (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.border", false]], "border_to_origin (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.border_to_origin", false]], "cache_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cache_dir", false]], "canonical_url (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.canonical_url", false]], "card-icon": [[0, "meta-field-card-icon", false]], "cards_exclude (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_exclude", false]], "cards_include (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_include", false]], "cards_layout (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout", false]], "cards_layout_dir (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_dir", false]], "cards_layout_options (class in sphinx_social_cards.validators)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options", false]], "cards_layout_options (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.cards_layout_options", false]], "center (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.center", false]], "center (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.center", false]], "color (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.color", false]], "color (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.color", false]], "color (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.color", false]], "color (class in pydantic_extra_types.color)": [[0, "pydantic_extra_types.color.Color", false]], "color (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.color", false]], "color (ellipse attribute)": [[13, "sphinx_social_cards.validators.layers.Ellipse.color", false]], "color (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.color", false]], "color (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.color", false]], "color (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.color", false]], "color (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.color", false]], "colors (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.colors", false]], "colors (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.colors", false]], "colors (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.colors", false]], "config (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Config", false]], "configuration value": [[18, "confval-repo_url", false]], "conical_gradient (class in sphinx_social_cards.validators.common)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient", false]], "content (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.content", false]], "contributions (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.contributions", false]], "contributor (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Contributor", false]], "contributors (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.contributors", false]], "corners (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.corners", false]], "date": [[0, "meta-field-date", false]], "debug (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Debug", false]], "debug (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.debug", false]], "description": [[0, "meta-field-description", false]], "description (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.description", false]], "description (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.description", false]], "description (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.description", false]], "docstitle (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.docstitle", false]], "ellipse (class in sphinx_social_cards.validators.layers)": [[13, "sphinx_social_cards.validators.layers.Ellipse", false]], "ellipse (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.ellipse", false]], "email (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.email", false]], "enable (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.enable", false]], "enable (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.enable", false]], "end (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.end", false]], "end (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.end", false]], "family (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.family", false]], "focal_point (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_point", false]], "focal_radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.focal_radius", false]], "followers (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.followers", false]], "following (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.following", false]], "font (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.font", false]], "font (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Font", false]], "font (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.font", false]], "forks (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.forks", false]], "github (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Github", false]], "grid (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid", false]], "grid_step (debug attribute)": [[0, "sphinx_social_cards.validators.Debug.grid_step", false]], "height (line attribute)": [[17, "sphinx_social_cards.validators.layers.Line.height", false]], "height (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.height", false]], "hirable (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.hirable", false]], "homepage (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.homepage", false]], "html_url (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.html_url", false]], "html_url (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.html_url", false]], "icon": [[0, "meta-field-icon", false]], "icon (class in sphinx_social_cards.validators.layers)": [[9, "sphinx_social_cards.validators.layers.Icon", false]], "icon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.icon", false]], "image (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.image", false]], "image (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.image", false]], "image-generator (directive)": [[1, "directive-image-generator", false]], "image_paths (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.image_paths", false]], "invert (mask attribute)": [[12, "sphinx_social_cards.validators.layout.Mask.invert", false]], "is_homepage (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.is_homepage", false]], "language": [[0, "meta-field-language", false]], "language (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.language", false]], "language (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.language", false]], "languages (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.languages", false]], "layer (class in sphinx_social_cards.validators.layout)": [[11, "sphinx_social_cards.validators.layout.Layer", false]], "layers (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.layers", false]], "layout (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Layout", false]], "layout (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.layout", false]], "license (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.license", false]], "line (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Line", false]], "line (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.line", false]], "linear_gradient (class in sphinx_social_cards.validators.common)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient", false]], "location (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.location", false]], "login (contributor attribute)": [[18, "sphinx_social_cards.plugins.github.context.Contributor.login", false]], "login (organization attribute)": [[18, "sphinx_social_cards.plugins.github.context.Organization.login", false]], "login (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.login", false]], "logo (cards_layout_options attribute)": [[10, "sphinx_social_cards.validators.Cards_Layout_Options.logo", false]], "mask (class in sphinx_social_cards.validators.layout)": [[12, "sphinx_social_cards.validators.layout.Mask", false]], "mask (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.mask", false]], "meta (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.meta", false]], "metadata field option": [[0, "meta-field-author", false], [0, "meta-field-card-icon", false], [0, "meta-field-date", false], [0, "meta-field-description", false], [0, "meta-field-icon", false], [0, "meta-field-language", false], [0, "meta-field-tags", false], [0, "meta-field-title", false]], "module": [[2, "module-sphinx_social_cards", false], [18, "module-sphinx_social_cards.plugins.github", false], [19, "module-sphinx_social_cards.plugins", false]], "name (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.name", false]], "name (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.name", false]], "offset (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Offset", false]], "offset (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.offset", false]], "open_issues (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.open_issues", false]], "organization (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Organization", false]], "organizations (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.organizations", false]], "overflow (typography attribute)": [[17, "sphinx_social_cards.validators.layers.Typography.overflow", false]], "owner (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Owner", false]], "owner (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.owner", false]], "page (class in sphinx_social_cards.validators.contexts)": [[11, "sphinx_social_cards.validators.contexts.Page", false]], "path (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.path", false]], "path (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.path", false]], "plugin (jinjacontexts attribute)": [[11, "sphinx_social_cards.validators.contexts.JinjaContexts.plugin", false]], "polygon (class in sphinx_social_cards.validators.layers)": [[15, "sphinx_social_cards.validators.layers.Polygon", false]], "polygon (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.polygon", false]], "preserve_aspect (background attribute)": [[3, "sphinx_social_cards.validators.layers.Background.preserve_aspect", false]], "preserve_aspect (icon attribute)": [[9, "sphinx_social_cards.validators.layers.Icon.preserve_aspect", false]], "preset (conical_gradient attribute)": [[4, "sphinx_social_cards.validators.common.Conical_Gradient.preset", false]], "preset (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.preset", false]], "preset (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.preset", false]], "public_gists (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_gists", false]], "public_repos (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.public_repos", false]], "radial_gradient (class in sphinx_social_cards.validators.common)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient", false]], "radius (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.radius", false]], "radius (rectangle attribute)": [[16, "sphinx_social_cards.validators.layers.Rectangle.radius", false]], "rectangle (class in sphinx_social_cards.validators.layers)": [[16, "sphinx_social_cards.validators.layers.Rectangle", false]], "rectangle (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.rectangle", false]], "repo (class in sphinx_social_cards.plugins.github.context)": [[18, "sphinx_social_cards.plugins.github.context.Repo", false]], "repo (github attribute)": [[18, "sphinx_social_cards.plugins.github.context.Github.repo", false]], "repo_url": [[18, "confval-repo_url", false]], "rotation (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.rotation", false]], "sides (polygon attribute)": [[15, "sphinx_social_cards.validators.layers.Polygon.sides", false]], "site_description (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_description", false]], "site_url (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.site_url", false]], "site_url (social_cards attribute)": [[0, "sphinx_social_cards.validators.Social_Cards.site_url", false]], "size (class in sphinx_social_cards.validators.layout)": [[10, "sphinx_social_cards.validators.layout.Size", false]], "size (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.size", false]], "size (layout attribute)": [[10, "sphinx_social_cards.validators.layout.Layout.size", false]], "social-card (directive)": [[1, "directive-option-social-card-conf-caption", false], [1, "directive-option-social-card-dry-run", false], [1, "directive-option-social-card-hide-conf", false], [1, "directive-option-social-card-hide-layout", false], [1, "directive-option-social-card-hide-meta-data", false], [1, "directive-option-social-card-layout-caption", false], [1, "directive-option-social-card-meta-data", false], [1, "directive-option-social-card-meta-data-caption", false], [1, "directive-social-card", false]], "social_cards (class in sphinx_social_cards.validators)": [[0, "sphinx_social_cards.validators.Social_Cards", false]], "sphinx_social_cards": [[2, "module-sphinx_social_cards", false]], "sphinx_social_cards.plugins": [[19, "module-sphinx_social_cards.plugins", false]], "sphinx_social_cards.plugins.github": [[18, "module-sphinx_social_cards.plugins.github", false]], "sphinx_social_cards_config_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_CONFIG_KEY", false]], "sphinx_social_cards_plugins_env_key (in module sphinx_social_cards.plugins)": [[19, "sphinx_social_cards.plugins.SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", false]], "spread (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.spread", false]], "spread (radial_gradient attribute)": [[8, "sphinx_social_cards.validators.common.Radial_Gradient.spread", false]], "stars (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.stars", false]], "start (arc attribute)": [[13, "sphinx_social_cards.validators.layers.Arc.start", false]], "start (linear_gradient attribute)": [[6, "sphinx_social_cards.validators.common.Linear_Gradient.start", false]], "style (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.style", false]], "subset (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.subset", false]], "tags": [[0, "meta-field-tags", false]], "tags (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.tags", false]], "theme (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.theme", false]], "title": [[0, "meta-field-title", false]], "title (page attribute)": [[11, "sphinx_social_cards.validators.contexts.Page.title", false]], "today (config attribute)": [[11, "sphinx_social_cards.validators.contexts.Config.today", false]], "topics (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.topics", false]], "twitter_username (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.twitter_username", false]], "type (owner attribute)": [[18, "sphinx_social_cards.plugins.github.context.Owner.type", false]], "typography (class in sphinx_social_cards.validators.layers)": [[17, "sphinx_social_cards.validators.layers.Typography", false]], "typography (layer attribute)": [[11, "sphinx_social_cards.validators.layout.Layer.typography", false]], "watchers (repo attribute)": [[18, "sphinx_social_cards.plugins.github.context.Repo.watchers", false]], "weight (font attribute)": [[17, "sphinx_social_cards.validators.layers.Font.weight", false]], "width (border attribute)": [[14, "sphinx_social_cards.validators.layers.Border.width", false]], "width (size attribute)": [[10, "sphinx_social_cards.validators.layout.Size.width", false]], "x (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.x", false]], "y (offset attribute)": [[10, "sphinx_social_cards.validators.layout.Offset.y", false]]}, "objects": {"": [[2, 1, 0, 1, "sphinx_social_cards", ""], [1, 5, 1, 1, "image-generator", ""], [1, 5, 1, 1, "social-card", ""], [1, 6, 1, "directive-option-social-card-conf-caption", "social-card:conf-caption", ""], [1, 6, 1, "directive-option-social-card-dry-run", "social-card:dry-run", ""], [1, 6, 1, "directive-option-social-card-hide-conf", "social-card:hide-conf", ""], [1, 6, 1, "directive-option-social-card-hide-layout", "social-card:hide-layout", ""], [1, 6, 1, "directive-option-social-card-hide-meta-data", "social-card:hide-meta-data", ""], [1, 6, 1, "directive-option-social-card-layout-caption", "social-card:layout-caption", ""], [1, 6, 1, "directive-option-social-card-meta-data", "social-card:meta-data", ""], [1, 6, 1, "directive-option-social-card-meta-data-caption", "social-card:meta-data-caption", ""], [0, 7, 1, 1, "author", "This can be used as a specific author name instead of using config.author in the jinja contexts."], [0, 7, 1, 1, "card-icon", "If the used sphinx theme already has assigned behavior to an icon, then the card-icon can be used instead."], [0, 7, 1, 1, "date", "This can be used as a hard-coded date instead of using config.today in the jinja contexts."], [0, 7, 1, 1, "description", "A metadata field at the top of the document's source."], [0, 7, 1, 1, "icon", "A way to override the icon used in a certain pages social card."], [0, 7, 1, 1, "language", "This can be used as a spelled out language name instead of using config.language in the jinja contexts."], [18, 8, 1, 1, "repo_url", "The repository's required identifying information (owner and repo) can also be parsed from the site_url if it uses a standard GitHub Pages address (https://.github.io/ )."], [0, 7, 1, 1, "tags", "This can be used as a comma-separated list of tags."], [0, 7, 1, 1, "title", "A metadata field at the top of the document's source."]], "pydantic_extra_types.color": [[0, 0, 1, 0, "Color", "Represents a color."]], "sphinx_social_cards": [[19, 1, 0, 1, "plugins", ""]], "sphinx_social_cards.plugins": [[19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_CONFIG_KEY", "The Sphinx config validated object from conf.py. This key always points to a Social_Cards object."], [19, 2, 1, 0, "SPHINX_SOCIAL_CARDS_PLUGINS_ENV_KEY", "The Sphinx builder environment key that points to the plugin jinja contexts."], [19, 3, 1, 0, "add_images_dir", "Adds a str or Path of new images to the image_paths list."], [19, 3, 1, 0, "add_jinja_context", "Adds a dict to the builder environment key for plugin jinja contexts."], [19, 3, 1, 0, "add_layouts_dir", "Adds a str or Path of new layouts to the cards_layout_dir list."], [18, 1, 0, 1, "github", ""]], "sphinx_social_cards.plugins.github.context": [[18, 0, 1, 0, "Contributor", "added-ctx each item listed in the plugin.vcs.github.repo.contributors jinja context"], [18, 0, 1, 0, "Github", "added-ctx plugin.vcs.github jinja context"], [18, 0, 1, 0, "Organization", "added-ctx each item listed in the plugin.vcs.github.owner.organizations jinja context"], [18, 0, 1, 0, "Owner", "added-ctx plugin.vcs.github.owner jinja context"], [18, 0, 1, 0, "Repo", "added-ctx plugin.vcs.github.repo jinja context"]], "sphinx_social_cards.plugins.github.context.Contributor": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "contributions", "The account's contributions count."], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Github": [[18, 4, 1, 0, "owner", "The github account owner information."], [18, 4, 1, 0, "repo", "The github account repo information."]], "sphinx_social_cards.plugins.github.context.Organization": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "description", "The organization's profile description"], [18, 4, 1, 0, "login", "The account's name."]], "sphinx_social_cards.plugins.github.context.Owner": [[18, 4, 1, 0, "avatar", "The account's avatar image's URL."], [18, 4, 1, 0, "bio", "The account profile's brief description."], [18, 4, 1, 0, "blog", "A link to a blog site."], [18, 4, 1, 0, "email", "The publicly available email (if any)."], [18, 4, 1, 0, "followers", "The number of users that the account is following."], [18, 4, 1, 0, "following", "The number of users that are following the account."], [18, 4, 1, 0, "hirable", "A flag indicating the user is available for employment."], [18, 4, 1, 0, "html_url", "The URI to the GitHub.com site protocol-stripped"], [18, 4, 1, 0, "location", "The account profile's location."], [18, 4, 1, 0, "login", "The account's name."], [18, 4, 1, 0, "name", "The account user's human name."], [18, 4, 1, 0, "organizations", "A list of the Organizations to which the account belongs."], [18, 4, 1, 0, "public_gists", "The number of public gists for the account."], [18, 4, 1, 0, "public_repos", "The number of public repositories for the account."], [18, 4, 1, 0, "twitter_username", "The account user's twitter username."], [18, 4, 1, 0, "type", "The account's type (eg \"User\" or \"Organization\")."]], "sphinx_social_cards.plugins.github.context.Repo": [[18, 4, 1, 0, "contributors", "A list of the repository's contributors."], [18, 4, 1, 0, "description", "The repository description."], [18, 4, 1, 0, "forks", "The number of repository forks."], [18, 4, 1, 0, "homepage", "The repository's designated outreach website protocol-stripped"], [18, 4, 1, 0, "html_url", "The repository GitHub.com URI protocol-stripped"], [18, 4, 1, 0, "language", "The primarily used program language in the repository."], [18, 4, 1, 0, "languages", "A dict of the used program languages in the repository. Each key is a language's name (eg. \"Python\"), and each value is the corresponding language's percent used (eg \"97.8\")."], [18, 4, 1, 0, "license", "The name of the license(s)."], [18, 4, 1, 0, "name", "The name of the repository."], [18, 4, 1, 0, "open_issues", "The number of open repository issues."], [18, 4, 1, 0, "stars", "The number of repository stars."], [18, 4, 1, 0, "tags", "A list of the repository's tags (str). These values seem to be ordered in recent descending to oldest tagged commits."], [18, 4, 1, 0, "topics", "The list of search topics designated for the repository."], [18, 4, 1, 0, "watchers", "The number of repository watchers."]], "sphinx_social_cards.validators": [[10, 0, 1, 0, "Cards_Layout_Options", "There are some options that are used as default values for the layout's subsequent layers. These values are set with cards_layout_options and are added to the layout.* jinja context (for customizable re-use in layer attributes)."], [0, 0, 1, 0, "Debug", "To ease creation of custom layouts, optional debugging glyphs can be enabled in the generated social card images."], [0, 0, 1, 0, "Social_Cards", "A dict of configurations related to generating social media cards. Each attribute equates to a supported configuration option."]], "sphinx_social_cards.validators.Cards_Layout_Options": [[10, 4, 1, 0, "accent", "The color used as a foreground accentuating color. By default, this value is set to the palette[accent] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_color", "The fallback value used for a layer's background.color attribute in most pre-designed layouts. By default, this value is set to the palette[primary] color or \"#4051B2\" for themes other than sphinx-immaterial."], [10, 4, 1, 0, "background_image", "The fallback value used for a layer's background.image attribute. Default is None. This image will not be shown if the background_color has no alpha channel (transparency) value."], [10, 4, 1, 0, "color", "The color used for the foreground text in most pre-designed layouts. By default, this will be computed as \"white\" or \"black\" based on the background_color."], [10, 4, 1, 0, "font", "The font specification to be used."], [10, 4, 1, 0, "logo", "The icon used for branding of the site. By default, this will be the html_logo (or the sphinx-immaterial theme's icon[logo])."]], "sphinx_social_cards.validators.Debug": [[0, 4, 1, 0, "color", "The color used to draw the debugging outlines, labels, and grid. The color for the debugging text is automatically set based on this color value."], [0, 4, 1, 0, "enable", "If set to True, then debugging outlines and labels are drawn."], [0, 4, 1, 0, "grid", "If set to True (the default) and enabled, then a grid of dots are drawn."], [0, 4, 1, 0, "grid_step", "If grid is enabled, then this int specifies the distance (in pixels) between each dot in the grid. Defaults to 30."]], "sphinx_social_cards.validators.Social_Cards": [[0, 4, 1, 0, "cache_dir", "The directory (relative to the conf.py file) that is used to store cached data for generating the social cards. By default, this will create/use a directory named \"social_cards_cache\" located adjacent to the conf.py file."], [0, 4, 1, 0, "cards_exclude", "This list can be used to exclude certain pages from generating social cards. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_include", "This list can be used to include certain pages from cards_exclude list. Default is an empty list. clude-list"], [0, 4, 1, 0, "cards_layout", "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."], [0, 4, 1, 0, "cards_layout_dir", "The list of paths (absolute or relative to conf.py) where the cards_layout is located. In the case of similarly named layout files, the order in this list takes precedence."], [0, 4, 1, 0, "cards_layout_options", "A set (dict) of options that can be accessed via the layout.* jinja context. See cards_layout_options for more detail."], [0, 4, 1, 0, "debug", "A field to specify layout debugging helpers. See Debugging Layouts for more detail."], [0, 4, 1, 0, "description", "This option will be used as the description metadata for all generated pages. It can be overridden for individual pages using the description metadata role."], [0, 4, 1, 0, "enable", "Set this option to False to disable automatic generation of social cards for each page. The social-card directive can be used to invoke or override social card generation for a specific page."], [0, 4, 1, 0, "image_paths", "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 a path relative to the conf.py file."], [0, 4, 1, 0, "path", "This option specifies where the generated social card images will be written to. It's normally not necessary to change this option. Defaults to the documentation's output in the subfolder '_static/social_cards'."], [0, 4, 1, 0, "site_url", "This required option will be the base URL that social media platforms use to fetch the social card's image."]], "sphinx_social_cards.validators.common": [[4, 0, 1, 0, "Conical_Gradient", "A specification for linear gradients of colors."], [6, 0, 1, 0, "Linear_Gradient", "A specification for linear gradients of colors."], [8, 0, 1, 0, "Radial_Gradient", "A specification for linear gradients of colors."]], "sphinx_social_cards.validators.common.Conical_Gradient": [[4, 4, 1, 0, "angle", "The angle of the the line from center the represents the gradient's start and stop limits. This value (in degrees) is clamped to a value greater than or equal to 0 and less than 360. The angle of origin (0 degrees) is located at 3 o'clock and increases counter-clockwise. The scale of listed colors begins at 0.0 on this line and continues counter-clockwise until ending at 1.0 on this line."], [4, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [4, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [4, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."]], "sphinx_social_cards.validators.common.Linear_Gradient": [[6, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [6, 4, 1, 0, "end", "The ending position (offset) rel_root_offset This offset corresponds to the maximum 1.0 color-pos"], [6, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [6, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."], [6, 4, 1, 0, "start", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"]], "sphinx_social_cards.validators.common.Radial_Gradient": [[8, 4, 1, 0, "center", "The starting position (offset) rel_root_offset This offset corresponds to the minimum 0.0 color-pos"], [8, 4, 1, 0, "colors", "A mapping of colors to their corresponding positions in the gradient. Each item in this mapping is composed of key: value pairs in which:"], [8, 4, 1, 0, "focal_point", "The focal point (offset) used to give the gradient a perspective. By default, the value of center is used. If the specified offset is outside the circumference defined via radius, then this offset will be moved to the outer-most point on the circle that would be formed by the radius from the center."], [8, 4, 1, 0, "focal_radius", "The radius from the focal_point defines the aperture width of the gradient's perspective. This is highly relative to the center's radius. Furthermore, if the focal_radius forms a circumference than extends beyond the center's radius, then the gradient is effectively nullified and treated like a solid color (which coincides with the colors list maximum position, 1.0)."], [8, 4, 1, 0, "preset", "An optional preset gradient that has a pre-defined mapping of colors. Each preset is referenced by name (string) or by index (integer). See the presets document for a complete list of supported values (with generated examples)."], [8, 4, 1, 0, "radius", "The radius represents the ending position as a distance (in pixels) from the specified center offset. The resulting circumference corresponds to the maximum 1.0 color-pos"], [8, 4, 1, 0, "spread", "This attribute controls the colors' behavior outside the gradient's specified area. By default this is set to pad."]], "sphinx_social_cards.validators.contexts": [[11, 0, 1, 0, "Config", "A dict whose items expose some configuration options in conf.py. The following items are included in this context:"], [11, 0, 1, 0, "Page", "A dict whose items include the following:"]], "sphinx_social_cards.validators.contexts.Config": [[11, 4, 1, 0, "author", "The author value."], [11, 4, 1, 0, "docstitle", "The project value which is used as the site's title."], [11, 4, 1, 0, "language", "The full language name that corresponds to the language value"], [11, 4, 1, 0, "site_description", "The social_cards.description value."], [11, 4, 1, 0, "site_url", "The social_cards.site_url value. This value has the transport protocol (https://) automatically removed for convenience."], [11, 4, 1, 0, "theme", "A dict whose items correspond to the html_theme_options. This dict is very dependent on the choice of sphinx theme and what it defines in its theme.conf file."], [11, 4, 1, 0, "today", "The today value. Defaults to current date using \" \" format."]], "sphinx_social_cards.validators.contexts.JinjaContexts": [[11, 4, 1, 0, "layout", "A dict whose items correspond to the cards_layout_options."], [11, 4, 1, 0, "plugin", "A dict whose items correspond to compatible plugins' contexts."]], "sphinx_social_cards.validators.contexts.Page": [[11, 4, 1, 0, "canonical_url", "A URL of the current page relative to the site_url value."], [11, 4, 1, 0, "is_homepage", "A bool value that indicates if the current page is the root of the site."], [11, 4, 1, 0, "meta", "A dict whose items correspond to the page's Metadata (or meta element(s) created via the meta directive)."], [11, 4, 1, 0, "title", "The value of the title of the page for which the card is generated."]], "sphinx_social_cards.validators.layers": [[13, 0, 1, 0, "Arc", "This attribute allows specifying starting and ending angles that render as an arc of a circle."], [3, 0, 1, 0, "Background", "When combining these attributes, the image is tinted with the color."], [14, 0, 1, 0, "Border", "The border's width in pixels. Defaults to 0."], [13, 0, 1, 0, "Ellipse", "This layer attribute renders an ellipse using the layer's size and offset to define the outlining bounding box."], [17, 0, 1, 0, "Font", "The specification that describes the font to be used."], [9, 0, 1, 0, "Icon", "When combining these attributes, the image is colorized by the specified color."], [17, 0, 1, 0, "Line", "These properties are used to calculate the font's size based on the layer's absolute maximum size."], [15, 0, 1, 0, "Polygon", "This layer attribute provides a way of drawing polygons with varying number of sides."], [16, 0, 1, 0, "Rectangle", "This layer attribute provides a way of drawing rectangles with rounded corners."], [17, 0, 1, 0, "Typography", "The border specification defines the behavior of rendering an outline around each character."]], "sphinx_social_cards.validators.layers.Arc": [[13, 4, 1, 0, "end", "The ending angle."], [13, 4, 1, 0, "start", "The starting angle."]], "sphinx_social_cards.validators.layers.Background": [[3, 4, 1, 0, "color", "The color used as the background fill color. This color will overlay the entire background.image (if specified). So be sure to add transparency (an alpha color value) when using both a background image and color."], [3, 4, 1, 0, "image", "The path to an image used as the card's background. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [3, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Border": [[14, 4, 1, 0, "color", "The border's color."], [14, 4, 1, 0, "width", "The border's width in pixels. Defaults to 0."]], "sphinx_social_cards.validators.layers.Ellipse": [[13, 4, 1, 0, "arc", "The specification for drawing only an arc of an ellipse."], [13, 4, 1, 0, "border", "The shape's outlining border specification."], [13, 4, 1, 0, "border_to_origin", "This switch controls the rendering of the border when arc is specified. If the arc attribute is not specified, then this switch has no effect."], [13, 4, 1, 0, "color", "The shape's fill color."]], "sphinx_social_cards.validators.layers.Font": [[17, 4, 1, 0, "family", "This option specifies which font to use for rendering the social card, which can be any font hosted by Fontsource. Default is \"Roboto\" if not using the sphinx-immaterial theme. However, the sphinx-immaterial theme's font option is used as a default if that theme is used."], [17, 4, 1, 0, "path", "The path to the TrueType font (*.ttf). If this is not specified, then it is set in accordance with the a cache corresponding to the family, style, weight, and subset options. If explicitly specified, then this value overrides the family, style, weight, and subset options."], [17, 4, 1, 0, "style", "The style of the font to be used. Typically, this can be italic or normal, but it depends on the styles available for the chosen family."], [17, 4, 1, 0, "subset", "A subset type used for the font. If not specified, this will use the default defined for the font (eg. \"latin\")."], [17, 4, 1, 0, "weight", "The weight of the font used. If this doesn't match the weights available, then the first weight defined for the font is used and a warning is emitted. Default is 400."]], "sphinx_social_cards.validators.layers.Icon": [[9, 4, 1, 0, "color", "The color used as the fill color. The actual image color is not used when specifying this, rather the non-transparent data is used as a mask for this value."], [9, 4, 1, 0, "image", "An image file's path. This path can be absolute or relative to one of the paths specified in social_cards.image_paths."], [9, 4, 1, 0, "preserve_aspect", "If an image is used that doesn't match the layer's size, then the image will be resized accordingly. This option can be used to control which horizontal width or vertical height or both (true) constraints are respected. Set this option to false to disable resizing the image. By default, this option is set to true."]], "sphinx_social_cards.validators.layers.Line": [[17, 4, 1, 0, "amount", "The maximum number of lines that can be used in the layer."], [17, 4, 1, 0, "height", "The relative height allotted to each line. This has a direct affect on spacing between lines because each layer has an absolute maximum size."]], "sphinx_social_cards.validators.layers.Polygon": [[15, 4, 1, 0, "border", "The shape's outlining border specification."], [15, 4, 1, 0, "color", "The shape's fill color."], [15, 4, 1, 0, "rotation", "The angles (in degrees) of arbitrary rotation (increasing counter-clockwise)."], [15, 4, 1, 0, "sides", "The specification of the polygon's sides. This can be an integer or offset-list."]], "sphinx_social_cards.validators.layers.Rectangle": [[16, 4, 1, 0, "border", "The shape's outlining border specification."], [16, 4, 1, 0, "color", "The shape's fill color."], [16, 4, 1, 0, "corners", "This YAML list of strings specifies which corners are rounded. By default all corners are rounded. The supported values are:"], [16, 4, 1, 0, "radius", "The radius of the rounded corner in pixels. Defaults to 0 (no rounding)."]], "sphinx_social_cards.validators.layers.Typography": [[17, 4, 1, 0, "align", "The alignment of text used. This is a string in which the space-separated words respectively describe the horizontal and vertical alignment."], [17, 4, 1, 0, "border", "The border specification defines the behavior of rendering an outline around each character."], [17, 4, 1, 0, "color", "The color to be used for the displayed text. If not specified, then this defaults to cards_layout_options.color."], [17, 4, 1, 0, "content", "The text to be displayed. This can be a Jinja syntax that has access to the card's jinja contexts."], [17, 4, 1, 0, "font", "The specified font to use. If not specified, then this defaults to values in cards_layout_options.font."], [17, 4, 1, 0, "line", "The line specification which sets the amount of lines and the height of each line. This is used to calculate the font's size."], [17, 4, 1, 0, "overflow", "Set this option to true to automatically shrink the font size enough to fit within the layer's size. By default (false), text will be truncated when the layer' capacity is reached, and an ellipsis will be added."]], "sphinx_social_cards.validators.layout": [[11, 0, 1, 0, "Layer", "Each layer can have different attributes. A typical layer has size and offset attributes with 1 additional attribute detailing a background or icon or typography or rectangle or ellipse. However, these attributes may combined as needed."], [10, 0, 1, 0, "Layout", "The size attribute is not required (see width and height for default values), but the layers attribute is required."], [12, 0, 1, 0, "Mask", "If specified, this attribute will define a bump mask. This value can only be 1 layer with an optional invert attribute. Any transparent part of the mask layer will be removed from the current layer for which the mask is defined."], [10, 0, 1, 0, "Offset", "An attribute to describe a layer's positional offset."], [10, 0, 1, 0, "Size", "An attribute to describe a layer's or layout's size."]], "sphinx_social_cards.validators.layout.Layer": [[11, 4, 1, 0, "background", "An optional background."], [11, 4, 1, 0, "ellipse", "An optional shapes/ellipse."], [11, 4, 1, 0, "icon", "An optional icon."], [11, 4, 1, 0, "mask", "An optional mask."], [11, 4, 1, 0, "offset", "The layer offset. Defaults to { x: 0, y: 0 }."], [11, 4, 1, 0, "polygon", "An optional shapes/polygon."], [11, 4, 1, 0, "rectangle", "An optional shapes/rectangle."], [11, 4, 1, 0, "size", "The layer size. Defaults to values inherited from the layout.size."], [11, 4, 1, 0, "typography", "An optional typography."]], "sphinx_social_cards.validators.layout.Layout": [[10, 4, 1, 0, "layers", "A YAML list of layers in the layout that define the entire content of the layout."], [10, 4, 1, 0, "size", "The card's absolute maximum size. Any layers with no size specified will fallback to this layout.size. If this is not specified, then the layout uses the default width and height values."]], "sphinx_social_cards.validators.layout.Mask": [[12, 4, 1, 0, "invert", "Use this bool attribute to cause the mask layer's transparency to become inverted. This is only useful if excluding pixels from the layer's image is desired."]], "sphinx_social_cards.validators.layout.Offset": [[10, 4, 1, 0, "x", "The offset on the X axis (relative to the top-left corner of the card). Defaults to 0."], [10, 4, 1, 0, "y", "The offset on the Y axis (relative to the top-left corner of the card). Defaults to 0."]], "sphinx_social_cards.validators.layout.Size": [[10, 4, 1, 0, "height", "The height of the layer (relative to the offset). Defaults to 630 pixels height."], [10, 4, 1, 0, "width", "The width of the layer (relative to the offset). Defaults to 1200 pixels width."]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "data", "Python data"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"], "5": ["rst", "directive", "reStructuredText directive"], "6": ["rst", "directive:option", "reStructuredText directive-option"], "7": ["std", "meta-field", "metadata field option"], "8": ["std", "confval", "configuration value"]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:data", "3": "py:function", "4": "py:attribute", "5": "rst:directive", "6": "rst:directive:option", "7": "std:meta-field", "8": "std:confval"}, "terms": {"": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "0": [0, 4, 5, 6, 8, 10, 11, 13, 14, 15, 16, 17], "000": 0, "000000": 0, "00000000": 17, "0000003f": [9, 12], "0000007f": 11, "000000ab": 3, "05": 0, "0ff1ce": [10, 11], "1": [0, 4, 5, 6, 8, 10, 11, 12, 17, 18], "100": [0, 8, 10, 11, 12, 16], "1010": 0, "102": 0, "1030": 0, "1040": 0, "1047": 0, "106": 0, "1080": [0, 17], "110": 17, "1140": 6, "115": [13, 15, 16], "116": 11, "1170": 5, "120": 0, "1200": [0, 10, 11], "125": [10, 17], "13": 11, "130": 0, "132": [0, 11], "135": 13, "146": [0, 11], "15": [0, 1, 11], "150": [0, 1, 5, 9, 12, 17], "158": 12, "160": 0, "165": [13, 16], "166": 10, "175": [0, 11], "18": 11, "180": [0, 4, 15], "19": 0, "2": [0, 2, 10, 11, 12, 15, 17], "20": [0, 13, 15], "200": [1, 4, 8, 11, 12, 15, 16, 17], "2023": 0, "206": 11, "210": [0, 11], "215": 12, "222": 11, "225": [13, 16], "23": 11, "230": 11, "237": 11, "239": 11, "240": [9, 10, 11], "241": 11, "25": [0, 1, 12, 13, 17], "250": [8, 10, 11], "255": 0, "260": 0, "27": 4, "270": [0, 15], "2bndy5": [0, 1, 2, 10, 18, 19], "3": [0, 4, 11, 12, 13, 15, 17], "30": [0, 5, 10, 15, 16], "300": [0, 5, 8, 10, 12, 13, 15, 16], "310": 0, "315": [4, 5, 6, 8, 12, 13], "32": 10, "330": 0, "35": [10, 11], "350": [0, 1, 13, 16], "360": [0, 4, 17], "375": 16, "38": 0, "4": [0, 2, 15], "40": 0, "400": [0, 1, 4, 8, 11, 13, 15, 16, 17], "4051b2": [10, 12, 13, 15, 16, 17], "4051b5": [3, 9, 17], "45": [0, 4, 5, 13, 15], "450": [0, 12, 13, 16], "457": 0, "47": [0, 11], "48": 5, "480": 0, "5": [0, 4, 6, 8, 17], "50": [0, 1, 5, 8, 12, 13, 16, 17], "500": [0, 12, 13, 16], "520": 0, "522": 0, "525": 9, "530": 0, "54": [0, 11], "570": [0, 6], "58": 8, "6": [11, 15], "60": [0, 5, 6, 17], "600": [0, 4, 5, 6, 8, 10, 11, 12, 15, 16, 17], "61": [0, 11], "630": [0, 10, 11], "65": [10, 13, 16], "7": 10, "70": 0, "700": 0, "75": [0, 17], "8": [0, 18], "80": 0, "820": 0, "83": 11, "84": [4, 6, 8, 11], "85": 0, "87": 0, "88": [0, 11], "9": [0, 15], "90": [0, 10, 15], "920": 0, "94": [0, 11], "960": 0, "97": 18, "99": [0, 11], "990": 0, "9999": 8, "A": [0, 1, 4, 6, 7, 8, 10, 11, 15, 17, 18, 19], "As": 11, "Be": 0, "Being": 0, "But": 11, "By": [0, 3, 6, 8, 9, 10, 13, 16, 17, 18], "For": [9, 11, 19], "If": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "In": [0, 5, 10, 11, 15], "It": [0, 11, 19], "No": 1, "Not": [11, 19], "On": [0, 18], "Such": 19, "The": [0, 1, 2, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "Then": [10, 19], "There": [0, 2, 10, 14], "These": [10, 14, 17, 18], "To": [0, 11, 18], "With": 11, "__file__": 19, "_fg_color": 17, "_static": 0, "ablog": 0, "abort": 17, "about": [0, 4, 6, 8, 10], "abov": 5, "abovetheski": 0, "absolut": [0, 3, 4, 6, 8, 9, 10, 17, 19], "accent": [10, 11], "accentu": 10, "accept": 1, "access": [0, 17, 18], "accord": [17, 18], "accordingli": [3, 9, 17], "account": 18, "actual": [9, 10, 11], "ad": [0, 10, 11, 17], "adapt": 0, "add": [0, 1, 3, 11, 18, 19], "add_images_dir": 19, "add_jinja_context": 19, "add_layouts_dir": 19, "addit": [0, 11], "addition": [2, 11], "address": 18, "adjac": [0, 10, 11], "adjust": 17, "advanc": 0, "advis": 11, "affect": [0, 17], "after": [11, 12, 17], "aka": [0, 2, 11], "alert": 0, "alias": 11, "align": [0, 1, 10, 11, 12], "all": [0, 1, 11, 14, 16], "allot": 17, "allow": [0, 13, 17], "alpha": [0, 3, 9, 10, 11], "alreadi": [0, 11, 19], "also": [0, 2, 5, 11, 15, 18], "alter": [0, 1], "altern": 7, "alwai": [11, 15, 19], "amount": [0, 10, 12, 17], "an": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19], "angl": [0, 4, 5, 13, 15], "ani": [0, 4, 6, 8, 10, 11, 12, 15, 17, 18, 19], "anoth": [0, 19], "apertur": 8, "api": [17, 18], "app": 19, "appdir": 18, "appear": 11, "append": [0, 3, 9], "appli": [4, 11], "applic": 19, "approach": 0, "appropri": 17, "ar": [1, 2, 3, 4, 6, 8, 9, 10, 14, 16, 17, 18, 19], "arbitrari": 15, "arc": 13, "area": [6, 8], "argument": [1, 10], "around": 17, "artifact": 16, "assert": 1, "assign": 0, "assum": [0, 3, 9], "attribut": [0, 5, 6, 8, 11, 14], "authent": 18, "author": [0, 11], "automat": [0, 1, 11, 17], "avail": [0, 2, 7, 17, 18], "avatar": [0, 18], "avatar_s": 0, "avoid": 18, "awesom": 0, "axi": 10, "azur": 0, "b": [0, 18], "ba": [3, 9], "background": [0, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "background_color": [0, 1, 5, 10, 11], "background_icon": 0, "background_imag": [0, 10], "bar": 0, "base": [0, 10, 17], "basic": [11, 17], "becaus": [0, 4, 10, 11, 17], "becom": [9, 12], "been": 0, "befor": [0, 10, 11], "begin": [4, 11], "behav": 0, "behavior": [0, 6, 8, 10, 17], "being": 1, "belong": 18, "below": 1, "benefici": 17, "better": 10, "between": [0, 2, 13, 17], "bewar": [2, 17], "beyond": 8, "bg_color": [0, 11], "bigger": 17, "bio": 18, "bitbucket": 19, "black": [0, 4, 6, 8, 9, 10], "block": [0, 1, 3, 11], "blog": 18, "blue": [1, 4, 6, 8, 11], "bold": [0, 17], "bool": [0, 3, 9, 11, 12, 13, 17, 18], "bootstrap": 19, "border": [0, 1, 12, 13, 14, 15, 16, 17], "border_to_origin": 13, "both": [0, 1, 3, 9], "bottom": [0, 11, 15, 16, 17], "bound": 13, "boundari": 0, "box": [0, 13], "brand": [0, 10], "break": [11, 17], "brendan": 0, "breviti": 10, "brief": 18, "briefli": 11, "browser": 0, "build": [11, 17, 19], "builder": 19, "builtin": [2, 11], "bump": 12, "bunch": 11, "bundl": [0, 2], "cach": 17, "cache_dir": [0, 18], "calcul": 17, "calendar": 0, "call": [14, 19], "can": [0, 1, 2, 3, 4, 9, 10, 11, 12, 15, 17, 18, 19], "cannot": [0, 1, 5, 11, 15, 17], "canonical_url": 11, "capabl": 0, "capac": 17, "caption": 1, "card": [0, 1, 3, 4, 6, 8, 11, 17, 18], "cards_exclud": 0, "cards_includ": 0, "cards_layout": [0, 1, 10, 11], "cards_layout_dir": [0, 10, 11, 19], "cards_layout_opt": [0, 1, 5, 10, 11, 17], "care": 19, "case": [0, 11, 15, 19], "caus": [12, 19], "center": [0, 1, 3, 4, 5, 8, 9, 10, 11, 12, 15, 17], "certain": 0, "chang": [1, 10, 11], "changelog": 0, "channel": 10, "charact": [0, 11, 17], "check": 0, "chines": 0, "choic": 11, "choos": [3, 9, 10, 13, 14, 15, 16, 17], "chosen": [17, 18], "circl": [8, 11, 13, 15], "circumfer": 8, "cjk": 0, "clamp": 4, "class": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "clock": [4, 13], "clockwis": [4, 13, 15], "clone": 19, "closer": 10, "closest": 0, "code": [0, 9, 11], "coincid": 8, "collabor": 0, "color": [1, 3, 4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17], "color_v": [0, 11], "com": [2, 18, 19], "combin": [3, 9, 11], "come": [0, 1, 11], "comma": 0, "comment": 11, "commit": 18, "common": 14, "compar": 1, "compat": 11, "complet": [0, 4, 6, 8, 11], "compos": [4, 6, 8, 11], "comprehens": 17, "comput": 10, "conceptu": 4, "condition": 11, "conf": [0, 1, 2, 5, 10, 11, 18, 19], "config": [0, 11, 19], "configur": [1, 2, 10, 11], "confus": [5, 11], "conic": [0, 5], "conical_gradi": [0, 3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17], "connect": 19, "consid": 1, "consist": 11, "constrain": 15, "constraint": [3, 9], "contain": [0, 7], "content": [0, 1, 10, 11, 12, 17, 19], "context": [0, 10, 17], "continu": [0, 4], "contribut": 18, "contributor": 18, "control": [0, 2, 3, 6, 8, 9, 11, 13, 14], "conveni": [0, 5, 11, 19], "convent": 11, "convention": 11, "convert": 11, "coordin": 4, "corner": [0, 4, 6, 8, 10, 11, 15, 16], "correspond": [0, 4, 6, 7, 8, 11, 17, 18], "could": [5, 11, 17], "count": 18, "counter": [4, 15], "cours": 11, "creat": [0, 1, 10, 11, 18], "creation": 0, "crop": 12, "css": 0, "ctx": 19, "current": [11, 12, 19], "custom": [0, 1, 2, 11, 15, 17, 18], "customiz": 10, "d": [0, 18], "dai": [11, 18], "dark": [11, 18], "dash": [10, 11], "data": [0, 1, 9], "datatyp": 0, "date": 11, "debug": [5, 10], "decagram": 0, "declar": [0, 5], "def": [18, 19], "default": [1, 3, 4, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "defin": [0, 4, 5, 6, 8, 10, 11, 12, 13, 15, 17], "degre": [4, 13, 15], "demonstr": 18, "denot": [10, 11], "depend": [0, 11, 15, 17], "deploy": 19, "deriv": 1, "descend": 18, "describ": [0, 2, 4, 6, 8, 10, 11, 17], "descript": [1, 10, 11, 18], "design": [0, 1, 10, 11, 18, 19], "desir": [0, 12], "despit": 0, "detail": [0, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 19], "determin": 15, "diamet": 11, "dict": [0, 4, 6, 8, 11, 18, 19], "differ": 19, "direct": [0, 2, 10, 11, 17], "directli": [17, 18], "directori": [0, 11, 19], "disabl": [0, 3, 9], "displai": [1, 17], "distanc": [0, 8], "distinct": 15, "distribut": 0, "do": [0, 19], "doc": [0, 11, 17], "docstitl": [0, 11], "document": [0, 1, 2, 4, 6, 8, 10, 11], "doe": [0, 2, 3, 4, 6, 8, 9, 11], "doesn": [0, 3, 9, 17], "doherti": 0, "don": 1, "done": [11, 19], "dot": 0, "download": 0, "draw": [0, 11, 13, 15, 16], "drawn": [0, 12, 13], "dry": 1, "due": 17, "dynam": 11, "each": [0, 4, 6, 7, 8, 10, 11, 15, 16, 17, 18], "eas": 0, "easili": [2, 11], "edg": 15, "effect": [8, 13, 15], "eg": [0, 3, 9, 11, 17, 18], "either": [0, 5, 18], "element": [0, 11], "elid": 10, "elif": 0, "ellips": [0, 1, 4, 8, 11, 12, 14, 15], "ellipsi": 17, "els": [0, 11, 18], "email": 18, "emb": 17, "embed": [0, 2], "emit": 17, "employ": 18, "empti": 0, "enabl": [0, 2, 10], "end": [0, 4, 5, 6, 8, 11, 13, 17], "endblock": [0, 11], "endfor": 11, "endif": [0, 11], "endpoint": [13, 18], "enough": 17, "ensur": 0, "entir": [3, 10], "entri": 0, "environ": [11, 18, 19], "equal": [4, 15], "equat": 0, "equival": [4, 6, 8], "error": 19, "etc": 18, "even": [11, 17], "event": 19, "everi": 11, "exampl": [0, 1, 4, 5, 6, 8, 11, 18, 19], "exce": 17, "excel": 11, "except": [0, 17], "exclud": [0, 11, 12], "exist": [18, 19], "expand": 12, "explan": [5, 11], "explicitli": 17, "expos": 11, "express": 11, "extend": [0, 8, 11], "extens": [0, 1, 2, 11, 18, 19], "extra": [2, 11], "f": 11, "fallback": [10, 11], "fals": [0, 3, 9, 13, 17], "famili": [0, 10, 17], "fanci": 17, "featur": [2, 4], "fetch": [0, 17, 18], "few": 14, "ff000037": 11, "ffffff": 0, "ffffff3f": 12, "ffffff80": 0, "fg_color": [0, 11], "field": [0, 10], "file": [0, 1, 10, 11], "filenam": [3, 9], "fill": [3, 9, 13, 15, 16], "find": 11, "finit": [0, 2], "first": [11, 17, 19], "fit": [3, 9, 17], "flag": [1, 18], "float": [4, 6, 8, 13, 14, 15, 16, 17, 18], "focal": 8, "focal_point": 8, "focal_radiu": 8, "folder": [0, 11, 19], "follow": [0, 2, 8, 11, 18, 19], "font": [10, 11], "font_color": [0, 11], "fontawesom": 0, "fontsourc": [0, 17], "foreground": 10, "forget": 1, "fork": 18, "form": [0, 5, 8, 11, 15], "format": [0, 11], "from": [0, 1, 2, 4, 8, 11, 12, 16, 17, 18, 19], "full": [11, 17], "fulli": 17, "function": 19, "further": 11, "furthermor": 8, "gener": [0, 1, 2, 4, 6, 7, 8, 10, 11, 18, 19], "get": [10, 11, 18, 19], "get_cache_dir": 18, "gist": 18, "git": [0, 19], "github": [0, 1, 2, 10, 19], "github_rest_api_token": 18, "gitignor": 0, "give": 8, "given": [0, 1], "glob": 0, "glyph": 0, "good": 10, "googl": 0, "gradient": 11, "greater": [4, 8], "green": [1, 4, 6, 8, 11, 12, 13, 15, 16], "grid": [0, 10], "grid_step": 0, "ha": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15, 17, 19], "half": 16, "hard": [0, 9, 11], "hashtag": 0, "have": [0, 4, 6, 8, 11, 17, 19], "head": 0, "heavili": [2, 10], "height": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 15, 16, 17], "hello": 19, "help": 11, "helper": 0, "here": [10, 11, 18, 19], "hexadecim": 0, "hide": 1, "highli": 8, "hirabl": 18, "hold": [11, 19], "home": 18, "homepag": 18, "hook": 19, "horizont": [3, 9, 17], "host": [0, 2, 17, 19], "how": [2, 4, 6, 8, 10, 11, 15, 18], "howev": [0, 1, 5, 11, 17], "hsl": [0, 10], "html": 0, "html_base_url": 11, "html_logo": [0, 10], "html_theme_opt": [11, 18], "html_url": 18, "http": [0, 1, 2, 10, 11, 18, 19], "human": 18, "hyphen": 19, "i": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "icon": [1, 2, 10, 11, 12], "icon_s": 0, "id": 18, "idea": 10, "identifi": 18, "ignor": [0, 15], "imag": [0, 1, 2, 3, 9, 10, 11, 12, 18], "image_path": [0, 2, 3, 9, 19], "images_dir": 19, "immateri": [0, 10, 17, 18], "implement": [0, 2, 4], "impli": 2, "import": 19, "inclin": 0, "includ": [0, 3, 9, 11, 19], "inclus": [4, 6, 8], "increas": [4, 13, 15], "indent": [1, 11], "index": [4, 6, 8], "indic": [0, 11, 18], "individu": [0, 10, 16, 17], "influenc": 2, "inform": [9, 11, 19], "init": 19, "inject": 1, "inner": 16, "insensit": 0, "inspect": [10, 11], "instal": [18, 19], "instanc": 11, "instead": [0, 1, 11, 17, 19], "instruct": 11, "int": [0, 4, 6, 8, 10, 11, 15, 16, 17, 18], "integ": [4, 6, 7, 8, 15], "integr": 0, "intend": 1, "interfac": 19, "interoper": 2, "interpret": 11, "invert": [11, 12], "invok": 0, "involv": 19, "io": [0, 1, 10, 18], "is_homepag": 11, "isn": 5, "issu": 18, "ital": [0, 10, 17], "item": [0, 4, 6, 8, 11, 18], "its": [0, 11, 18], "itself": 13, "j": 2, "japanes": 0, "jinja": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "jinja_ctx": 19, "jinjacontext": 11, "join": 0, "jp": 0, "jpg": 0, "json": 1, "june": 0, "just": [0, 1, 19], "keep": 11, "kei": [4, 6, 8, 18, 19], "knowledg": 10, "korean": 0, "kr": 0, "label": 0, "languag": [11, 18], "larg": 17, "larger": 15, "last": 11, "lastli": 2, "latin": 17, "layer": [0, 1, 4, 5, 6, 8, 10, 14, 19], "layertypographydataclass": 17, "layout": [1, 2, 3, 4, 5, 6, 8, 9, 12, 13, 15, 16, 17], "layouts_dir": 19, "lead": [0, 17], "left": [0, 4, 6, 8, 10, 15, 16], "less": [4, 15], "let": 11, "letter": 11, "level": 0, "librari": 18, "licens": 18, "like": [0, 8, 10, 11, 18], "limit": [4, 15, 18], "line": [0, 1, 4, 10, 11, 12], "linear": [0, 4, 5, 8, 11], "linear_gradi": [0, 3, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17], "link": 18, "linux": [0, 18], "list": [0, 1, 2, 4, 6, 7, 8, 10, 11, 15, 16, 19], "liter": [1, 3, 6, 8, 9, 16, 17], "littl": 5, "ll": 10, "load": 17, "local": 1, "localappdata": 18, "localtim": [0, 18], "locat": [0, 4, 10, 11, 15, 18], "login": 18, "logo": [0, 10, 11, 19], "long": [5, 17], "lower": [0, 18], "maco": [0, 18], "made": 0, "mai": [11, 15], "make": [11, 19], "manipul": [0, 1], "map": [4, 6, 8, 11], "mask": [0, 9, 11], "match": [0, 3, 9, 17], "materi": [0, 2], "matter": 11, "maxim": 15, "maximum": [6, 8, 10, 15, 17], "mean": [11, 13, 17], "meant": 1, "mechan": [1, 12], "media": [0, 1, 2, 10], "member": 18, "merg": 1, "messag": [1, 10], "meta": [0, 1, 11], "meta_color": 0, "meta_info_lin": 0, "meta_info_s": 0, "metadata": [1, 10, 11, 17], "metadata_color": 0, "mimic": 1, "mind": 0, "minim": 0, "minimum": [4, 6, 8, 16], "minut": 0, "mkdoc": 2, "modifi": 11, "modul": 19, "month": [11, 18], "more": [0, 3, 4, 6, 8, 9, 13, 14, 15, 16, 17, 19], "most": [8, 10], "mostli": 18, "move": [8, 15], "multi": [1, 11], "multipl": [0, 11], "multitud": 0, "must": [0, 4, 6, 8, 19], "my": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16, 19], "my_ctx": 19, "name": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 17, 18, 19], "namespac": 19, "narrow": 0, "necessari": [0, 5], "necessit": 11, "need": [0, 18, 19], "neg": [12, 17], "neither": [4, 6, 8], "never": [15, 17], "new": [10, 11, 18, 19], "newli": 11, "next": 11, "node": 2, "non": 9, "none": [3, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18], "nonetheless": 5, "normal": [0, 17], "notat": 19, "notic": [10, 11, 15, 17], "noto": 0, "now": [11, 19], "npm": 2, "null": [0, 8, 11], "nullifi": 8, "number": [0, 15, 17, 18], "o": [4, 13, 18], "object": 19, "occupi": 15, "occur": [4, 6, 8], "octicon": 0, "off": [13, 17], "offer": 0, "offset": [0, 1, 4, 6, 8, 9, 10, 11, 13, 15, 16, 17], "old": 18, "oldest": 18, "on_builder_init": 19, "onc": 18, "one": [0, 3, 5, 9], "onli": [0, 5, 11, 12, 13, 16], "open": 18, "open_issu": 18, "opengraph": 11, "optim": 2, "option": [0, 3, 4, 6, 8, 9, 11, 12, 18, 19], "orang": [1, 11], "order": [0, 4, 6, 8, 11, 18], "organ": 18, "orient": 0, "origin": [4, 9, 13, 19], "other": [0, 4, 10], "otherwis": 11, "our": 11, "out": [0, 3], "outer": 8, "outlin": [0, 10, 13, 14, 15, 16, 17], "output": 0, "outreach": 18, "outsid": [6, 8, 15], "over": [2, 19], "overflow": [0, 17], "overlai": 3, "overrid": [0, 1, 4, 6, 8, 11, 17, 19], "overridden": [0, 1, 10], "overwritten": 11, "own": 18, "packag": [2, 18], "pad": [6, 8], "page": [0, 1, 2, 7, 10, 11, 17, 18], "pair": [4, 6, 8], "palett": 10, "paragraph": 17, "parent": [18, 19], "parenthes": 7, "pars": [11, 18, 19], "parser": 11, "part": 12, "pass": [1, 11, 19], "path": [0, 3, 9, 10, 11, 17, 18, 19], "pathlib": 19, "pattern": 0, "per": [0, 10], "percent": 18, "perfect": 15, "perspect": 8, "phoenixstart": [4, 6, 8, 11], "phrase": 17, "pillow": [0, 17], "pip": [2, 18, 19], "pixel": [0, 8, 10, 12, 14, 16], "place": 0, "plan": 1, "platform": [0, 18], "pleas": [3, 9, 10, 11, 13, 14, 15, 16, 17, 19], "plugin": [2, 11], "png": [1, 3, 9, 10, 11, 12, 19], "point": [4, 6, 8, 15, 19], "polar": 4, "polygon": [11, 14], "posit": [4, 6, 8, 12, 15], "possibl": 19, "post": 0, "power": 0, "pre": [0, 4, 5, 6, 8, 10, 11, 17, 18, 19], "preced": [0, 19], "premiumwhit": [0, 11], "prepar": 19, "present": 0, "preserv": 17, "preserve_aspect": [3, 9], "preset": [0, 4, 5, 6, 8, 11], "prevent": 1, "preview": [0, 2], "primari": [1, 10], "primarili": 18, "prioriti": 11, "privat": 18, "process": 17, "product": 1, "profil": 18, "program": 18, "programmat": [11, 17], "project": [0, 2, 11, 19], "project_desc_color": [0, 11], "prompt": 19, "proof": 15, "proper": 11, "properti": [10, 17], "protocol": [11, 18], "prove": [12, 15], "provid": [0, 1, 2, 15, 16], "public": 18, "public_gist": 18, "public_repo": 18, "publicli": 18, "pull": 0, "purg": 18, "purpos": [0, 18], "py": [0, 1, 2, 5, 10, 11, 18, 19], "pydant": 2, "pyside6": 2, "python": [0, 11, 18, 19], "pyyaml": 2, "qt": 0, "quick": 11, "quickli": 19, "quot": 11, "radial": [0, 5], "radial_gradi": [3, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17], "radiu": [0, 1, 5, 8, 12, 16], "rainbow": [3, 10, 11, 12], "rais": [0, 17], "rang": [4, 6, 8, 11], "rate": 18, "rather": [1, 9], "re": 10, "reach": 17, "read": [0, 11], "readabl": 5, "readi": 19, "readm": 18, "recent": 18, "recommend": 19, "rectangl": [0, 1, 11, 12, 14], "rectangular": 15, "red": [1, 4, 6, 8, 11, 12, 13, 15, 16], "refer": [10, 11], "referenc": [0, 4, 6, 8], "reflect": [0, 6, 8, 11], "regardless": 5, "regular": [0, 15], "rel": [0, 3, 4, 6, 8, 9, 10, 11, 12, 15, 17], "relat": [0, 17], "reli": 10, "rememb": [8, 11], "remot": 0, "remov": [11, 12], "render": [0, 1, 11, 12, 13, 14, 15, 16, 17], "repeat": [6, 11], "replac": 11, "repo_url": 18, "repositori": [0, 18, 19], "repres": [0, 4, 8], "request": [0, 2, 18], "requir": [0, 2, 5, 10, 11, 18], "resiz": [3, 9], "respect": [3, 9, 17], "rest": [10, 11, 18], "result": [0, 1, 8, 11, 12], "return": 18, "reus": 0, "review": [1, 3, 9, 10, 13, 14, 15, 16, 17], "rgb": [0, 10, 11], "rgba": [0, 11], "right": [0, 15, 16], "rmtree": 18, "roboto": [0, 10, 17], "role": 0, "root": 11, "rotat": 15, "round": 16, "rst": [0, 1], "rule": 0, "run": [1, 19], "sai": 11, "same": [0, 1, 8, 11, 12, 17, 19], "san": 0, "sc": 0, "scale": 4, "search": [0, 18, 19], "section": [3, 7, 9, 10, 11, 13, 14, 15, 16, 17], "see": [0, 2, 3, 4, 6, 8, 9, 10, 19], "seem": [0, 18], "separ": [0, 17], "serv": 1, "set": [1, 3, 6, 8, 9, 10, 11, 12, 13, 17, 18], "setup": 19, "shape": [13, 15, 16, 17], "share": [0, 2, 17], "ship": 0, "should": [15, 17, 19], "show": 8, "shown": [5, 9, 10], "shrink": 17, "shutil": 18, "side": 15, "signifi": [5, 11], "similarli": 0, "simpl": [0, 1, 11], "simplifi": 0, "sinc": 0, "singl": 11, "site": [0, 10, 11, 18], "site_descript": [0, 11], "site_url": [0, 1, 10, 11, 18], "size": [0, 1, 3, 4, 8, 9, 10, 11, 13, 15, 16, 17], "slab": 0, "smaller": [15, 16, 17], "smallest": 15, "snake": 19, "so": [0, 3, 5, 11], "social": [0, 1, 10, 11, 17, 18], "social_card": [0, 1, 3, 5, 9, 10, 11, 19], "social_cards_cach": 0, "sole": 11, "solid": [4, 5, 6, 8], "some": [0, 2, 10, 11], "someon": 0, "sourc": [0, 1, 2, 11], "space": [11, 17], "special": 0, "specif": [2, 4, 5, 6, 8, 10, 13, 15, 16], "specifi": [0, 1, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 19], "spell": 0, "sphinx": [0, 1, 2, 10, 11, 17, 18], "sphinx_logo": [0, 9, 11, 12], "sphinx_social_card": [0, 17, 19], "sphinx_social_cards_config_kei": 19, "sphinx_social_cards_plugin": 19, "sphinx_social_cards_plugins_env_kei": 19, "split": 0, "spread": [0, 6, 11], "squar": 15, "ssc": 1, "standard": 18, "star": 18, "start": [0, 4, 5, 6, 8, 10, 11, 13, 17], "statement": 11, "stipul": 15, "stop": 4, "stopwatch": 0, "store": 0, "str": [0, 3, 4, 6, 8, 9, 10, 11, 17, 18, 19], "streamlin": 11, "strftime": [0, 18], "string": [0, 1, 4, 6, 7, 8, 11, 12, 16, 17], "strip": [0, 11, 17, 18], "stripe": 11, "stroke": [14, 17], "studi": 10, "style": 10, "styliz": 17, "sub": 11, "subdirectori": [0, 19], "subfold": 0, "subsequ": 10, "subset": [0, 17], "suffix": 0, "support": [2, 4, 5, 6, 8, 10, 11, 14, 16, 17], "sure": [0, 3], "surround": 11, "svg": [0, 2, 3, 9], "switch": 13, "syntact": 17, "syntax": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "system": [0, 4, 18], "t": [0, 1, 3, 5, 9, 17], "tactic": 0, "tag": [0, 11, 18], "tailor": 2, "take": [0, 19], "target": 1, "tc": 0, "templat": 19, "text": [0, 1, 10, 12, 17], "than": [4, 8, 10, 15, 16], "thei": [0, 1, 10, 11, 19], "them": 1, "theme": [0, 2, 10, 11, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "thin": 0, "those": 11, "thu": 17, "thumb": 0, "time": [0, 18], "time_fmt": [0, 18], "tint": 3, "titl": [1, 11, 17], "title_url_color": [0, 11], "todai": [0, 11, 18], "token": 18, "top": [0, 4, 6, 8, 10, 15, 16, 17], "topic": 18, "tradit": 0, "trail": [11, 17], "translat": 11, "transpar": [0, 3, 9, 10, 11, 12, 17], "transport": 11, "treat": [8, 15], "true": [0, 3, 9, 12, 13, 17], "truetyp": 17, "truncat": 17, "ttf": 17, "tutori": 19, "twitter": 18, "twitter_usernam": 18, "two": 15, "txt": 18, "type": [2, 5, 11, 17, 18], "typic": [0, 11, 17, 19], "typing_extens": 2, "typographi": [0, 1, 10, 11, 12, 19], "un": 18, "undefin": 11, "under": 0, "understand": 10, "unless": 18, "until": 4, "up": 11, "updat": 18, "upon": [10, 11], "uri": [1, 18], "url": [0, 11, 18], "us": [0, 1, 2, 3, 4, 5, 6, 9, 10, 12, 13, 14, 15, 17, 18, 19], "usag": 11, "user": 19, "user_cache_dir": 18, "usernam": 18, "valid": [0, 5, 17, 19], "valu": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 18], "vari": [0, 15], "variabl": [11, 18], "variant": [1, 11], "vc": 18, "veri": [5, 11], "versa": 2, "version": [11, 18], "vertic": [3, 9, 17], "via": [0, 8, 11, 18], "vice": 2, "visibl": [10, 16], "wa": [1, 11, 12], "wai": [0, 15, 16, 17], "want": 11, "warn": 17, "watcher": 18, "watermark": 0, "watermark_icon": [0, 11], "we": [5, 10, 11], "websit": 18, "weight": 17, "welcom": 0, "well": [0, 9], "whatev": 0, "when": [0, 3, 4, 6, 8, 9, 13, 17, 18, 19], "where": [0, 12], "which": [0, 3, 4, 6, 8, 9, 11, 12, 15, 16, 17, 18], "while": 5, "white": [0, 4, 5, 6, 8, 9, 10, 12, 15, 17], "whitespac": 17, "whoami": 18, "whose": 11, "wide": 11, "widematrix": 5, "width": [0, 1, 3, 4, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "wind": 17, "window": [0, 18], "within": [1, 3, 9, 10, 15, 17], "without": [0, 1, 9, 15], "word": 17, "work": [0, 5, 10, 19], "workflow": 0, "world": 19, "worri": 11, "worth": 0, "would": [0, 8, 11, 19], "wrap": 17, "write": 19, "written": [0, 1, 10], "x": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17], "y": [0, 1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18], "yaml": [0, 1, 10, 15, 16], "year": [11, 18], "yml": [0, 1, 3, 4, 6, 8, 9, 10, 11, 12, 13, 15, 16], "you": [0, 1, 10, 11, 19], "your": [0, 2, 11, 18, 19], "zero": 0}, "titles": ["Configuration", "Directives", "Social Cards", "Layer Background attribute", "Conical Gradients", "Gradient Colors", "Linear Gradients", "Preset Gradients", "Radial Gradients", "Layer Icon Attribute", "Customized Layouts", "Layer of a Layout", "Layer Mask attribute", "Layer Ellipse attribute", "Basic Shapes", "Layer Polygon attribute", "Layer Rectangle attribute", "Layer Typography Attribute", " sphinx_social_cards.plugins.github", "sphinx-social-cards Plugins"], "titleterms": {"": 12, "1": 7, "10": 7, "100": 7, "101": 7, "102": 7, "103": 7, "104": 7, "106": 7, "107": 7, "108": 7, "109": 7, "11": 7, "110": 7, "112": 7, "113": 7, "114": 7, "115": 7, "116": 7, "117": 7, "118": 7, "12": 7, "120": 7, "121": 7, "122": 7, "123": 7, "124": 7, "125": 7, "126": 7, "127": 7, "128": 7, "129": 7, "13": 7, "131": 7, "132": 7, "133": 7, "134": 7, "136": 7, "137": 7, "138": 7, "139": 7, "14": 7, "140": 7, "142": 7, "143": 7, "144": 7, "145": 7, "146": 7, "147": 7, "148": 7, "149": 7, "15": 7, "150": 7, "151": 7, "152": 7, "153": 7, "154": 7, "155": 7, "156": 7, "157": 7, "158": 7, "159": 7, "16": 7, "160": 7, "161": 7, "162": 7, "163": 7, "164": 7, "165": 7, "166": 7, "167": 7, "168": 7, "169": 7, "17": 7, "170": 7, "171": 7, "172": 7, "173": 7, "174": 7, "175": 7, "176": 7, "177": 7, "178": 7, "179": 7, "18": 7, "180": 7, "19": 7, "2": 7, "20": 7, "21": 7, "22": 7, "23": 7, "24": 7, "25": 7, "26": 7, "28": 7, "29": 7, "3": 7, "30": 7, "31": 7, "32": 7, "33": 7, "34": 7, "35": 7, "36": 7, "37": 7, "38": 7, "4": 7, "41": 7, "42": 7, "43": 7, "44": 7, "46": 7, "47": 7, "48": 7, "49": 7, "5": 7, "50": 7, "51": 7, "52": 7, "53": 7, "54": 7, "55": 7, "56": 7, "57": 7, "58": 7, "59": 7, "6": 7, "60": 7, "61": 7, "62": 7, "63": 7, "64": 7, "65": 7, "66": 7, "67": 7, "68": 7, "69": 7, "7": 7, "70": 7, "72": 7, "73": 7, "75": 7, "76": 7, "77": 7, "78": 7, "79": 7, "8": 7, "80": 7, "81": 7, "82": 7, "83": 7, "84": 7, "85": 7, "86": 7, "87": 7, "88": 7, "89": 7, "9": 7, "90": 7, "91": 7, "92": 7, "93": 7, "94": 7, "95": 7, "96": 7, "97": 7, "98": 7, "99": 7, "The": 11, "There": 17, "about": [11, 18], "abovetheski": 7, "accent": 0, "ad": [18, 19], "africanfield": 7, "alchemistlab": 7, "alias": 5, "align": 17, "amouramour": 7, "amycrisp": 7, "angelcar": 7, "api": 19, "applic": 4, "aquaguid": 7, "aquasplash": 7, "ar": [0, 5, 11, 15], "area": 15, "attribut": [3, 9, 10, 12, 13, 15, 16, 17], "avail": 19, "awesomepin": 7, "background": 3, "basic": 14, "between": 11, "bigmango": 7, "blacksea": 7, "bless": 7, "blog": 0, "burningspr": 7, "cach": [0, 18], "card": [2, 10, 19], "caution": 17, "chang": 0, "cheerfulcaramel": 7, "childcar": 7, "choos": 0, "clamp": 15, "cleanmirror": 7, "cloudyappl": 7, "cloudyknoxvil": 7, "cochitilak": 7, "coldeven": 7, "color": [0, 5, 11], "colorfulpeach": 7, "confidentcloud": 7, "configur": [0, 18], "conic": 4, "consist": 0, "context": [11, 18, 19], "cookiecutt": 19, "creat": 19, "crystallin": 7, "crystalriv": 7, "custom": 10, "date": 0, "debug": 0, "deepblu": 7, "deeprelief": 7, "default": 0, "demonstr": 1, "densewat": 7, "depend": [2, 18], "descript": 0, "deserthump": 7, "detail": 18, "differ": [0, 11], "direct": 1, "dirtybeauti": 7, "do": 11, "dustygrass": 7, "dynam": 0, "ellips": 13, "enabl": 18, "english": 0, "error": [11, 15, 16], "escap": 11, "eternalconst": 7, "everlastingski": 7, "extens": [3, 9], "fabledsunset": 7, "farawayriv": 7, "februaryink": 7, "file": [3, 9], "filter": 11, "flyhigh": 7, "flyinglemon": 7, "font": [0, 17], "forestinei": 7, "freshmilk": 7, "freshoasi": 7, "front": 0, "frozenberri": 7, "frozendream": 7, "frozenheat": 7, "fruitblend": 7, "full": 0, "gagarinview": 7, "gentlecar": 7, "github": 18, "glasswat": 7, "gradient": [0, 4, 5, 6, 7, 8], "grassshampoo": 7, "greatwhal": 7, "grownearli": 7, "happyacid": 7, "happyfish": 7, "happymemori": 7, "happyunicorn": 7, "healthywat": 7, "heavenpeach": 7, "heavyrain": 7, "hiddenjaguar": 7, "highflight": 7, "hint": [3, 9], "i": 17, "icon": [0, 9], "imag": 19, "implement": [5, 18], "import": [1, 11, 13, 17], "inform": 18, "inherit": 11, "inlin": 17, "instal": 2, "invert": 0, "itmeobrand": 7, "japanblush": 7, "jinja": 11, "juicycak": 7, "juicypeach": 7, "jungledai": 7, "kindsteel": 7, "ladogabottom": 7, "ladylip": 7, "landingaircraft": 7, "languag": 0, "layer": [3, 9, 11, 12, 13, 15, 16, 17], "layout": [0, 10, 11, 18, 19], "lecocktail": 7, "lemong": 7, "lightblu": 7, "lilymeadow": 7, "line": 17, "linear": 6, "list": 18, "lovekiss": 7, "magiclak": 7, "magicrai": 7, "mai": 0, "malibubeach": 7, "marblewal": 7, "marsparti": 7, "mask": 12, "matter": 0, "mean": 12, "meanfruit": 7, "metadata": 0, "midnightbloom": 7, "millenniumpin": 7, "mindcrawl": 7, "miss": [3, 9], "mixedhop": 7, "molehal": 7, "morningsalad": 7, "morpheusden": 7, "mountainrock": 7, "nearmoon": 7, "need": 11, "nega": 7, "newlif": 7, "newretrowav": 7, "newyork": 7, "nightcal": 7, "nightfad": 7, "nightparti": 7, "nightski": 7, "non": 0, "norsebeauti": 7, "northmiracl": 7, "note": [0, 2, 9, 11, 15, 17], "octobersil": 7, "offset": 12, "oldhat": 7, "onli": 1, "opengraph": 0, "option": [1, 10, 17], "orangejuic": 7, "other": 11, "over": 0, "oversun": 7, "owner": 18, "paloalto": 7, "pars": 17, "partybliss": 7, "passionateb": 7, "perfectblu": 7, "perfectwhit": 7, "phoenixstart": 7, "plugin": [18, 19], "plumbath": 7, "plumplat": 7, "politerumor": 7, "polygon": 15, "posit": 10, "premiumdark": 7, "premiumwhit": 7, "preset": 7, "proof": 8, "purpledivis": 7, "purpos": 1, "radial": 8, "rainyashvil": 7, "rarewind": 7, "rectangl": 16, "redsalv": 7, "refer": 19, "referenc": 11, "repeat": 8, "repo": 18, "restrict": 15, "richmet": 7, "ripemalinka": 7, "riskyconcret": 7, "riverc": 7, "royalgarden": 7, "saintpetersburg": 7, "saltmountain": 7, "sandstrik": 7, "sealord": 7, "seashor": 7, "seastrik": 7, "seealso": [1, 3, 5, 7, 9, 10, 11, 13, 14, 15, 16, 17], "set": 0, "shadywat": 7, "shape": 14, "sharpblu": 7, "sharpeyeeagl": 7, "shyrainbow": 7, "size": 12, "skyglid": 7, "sleeplessnight": 7, "smartindigo": 7, "smilingrain": 7, "snowagain": 7, "social": [2, 19], "softcherish": 7, "softgrass": 7, "softlipstick": 7, "solid": [0, 11], "solidston": 7, "spaceshift": 7, "specif": [0, 17], "sphinx": 19, "sphinx_social_card": 18, "spikynaga": 7, "spread": [4, 8], "springwarmth": 7, "starwin": 7, "strictnovemb": 7, "strongbliss": 7, "strongstick": 7, "stuff": 11, "style": [0, 17], "sub": 18, "sugarlollipop": 7, "summergam": 7, "sunnymorn": 7, "sunveggi": 7, "support": 0, "supremeski": 7, "sweetdessert": 7, "sweetperiod": 7, "syntax": [0, 11], "teennotebook": 7, "teenparti": 7, "templat": 11, "temptingazur": 7, "tip": [16, 18], "titl": 0, "truesunset": 7, "tutori": 11, "typographi": 17, "us": [8, 11], "usag": 2, "useless": 1, "user": 18, "valu": 11, "variabl": 0, "variant": 0, "viciousst": 7, "warmflam": 7, "warn": [5, 8, 11, 19], "weight": 0, "what": 11, "widematrix": 7, "wildappl": 7, "winterneva": 7, "witchdanc": 7, "within": 11, "yaml": 11, "younggrass": 7, "youngpass": 7, "zeusmiracl": 7}}) \ No newline at end of file
Layer Rectangle attribute
Radial Gradients
Linear Gradients