Merge pull request #494 from Blueprints-org/493-documentation-issue-wrong-latex-rendering-in-docs-fix-homereadme

Author: egarciamendez

.github/prompts/casus_formula.prompt.md

@@ -32,14 +32,14 @@ class Form6Dot10abNStrengthReductionFactor(Formula):
         self,
         f_ck: MPA,
     ) -> None:
-        r"""[$$\nu_{1}$$] Strength reduction factor for concrete cracked in shear [-].
+        r"""[$\nu_{1}$] Strength reduction factor for concrete cracked in shear [-].
 
         NEN-EN 1992-1-1+C2:2011 art.6.2.2(1) - Formula (6.10.aN and 6.10.bN)
 
         Parameters
         ----------
         f_ck : MPA
-            [$$f_{ck}$$] Characteristic compressive strength of concrete [$$MPa$$].
+            [$f_{ck}$] Characteristic compressive strength of concrete [$MPa$].
         """
         super().__init__()
         self.f_ck = f_ck

.github/prompts/comparison_formula.prompt.md

@@ -40,9 +40,9 @@ class Form5Dot38aCheckRelativeSlendernessRatio(Formula):
         Parameters
         ----------
         lambda_y : DIMENSIONLESS
-            [$$\lambda_{y}$$] Slenderness ratio in y-direction [-].
+            [$\lambda_{y}$] Slenderness ratio in y-direction [-].
         lambda_z : DIMENSIONLESS
-            [$$\lambda_{z}$$] Slenderness ratio in z-direction [$$N$$].
+            [$\lambda_{z}$] Slenderness ratio in z-direction [$N$].
         """
         super().__init__()
         self.lambda_y = lambda_y

.github/prompts/equation_formula.prompt.md

@@ -24,7 +24,7 @@ from blueprints.validations import raise_if_less_or_equal_to_zero, raise_if_nega
 
 
 class Form6Dot41W1Rectangular(Formula):
-    r"""Class representing formula 6.41 for the calculation of [$$W_1$$]."""
+    r"""Class representing formula 6.41 for the calculation of [$W_1$]."""
 
     label = "6.41"
     source_document = NEN_EN_1992_1_1_C2_2011
@@ -35,18 +35,18 @@ class Form6Dot41W1Rectangular(Formula):
         c_2: MM,
         d: MM,
     ) -> None:
-        r"""[$$W_1$$] Calculation of the area [$$mm^2$$].
+        r"""[$W_1$] Calculation of the area [$mm^2$].
 
         NEN-EN 1992-1-1+C2:2011 art.6.4.3(3) - Formula (6.41)
 
         Parameters
         ----------
         c_1 : MM
-            [$$c_1$$] Column dimension parallel to the eccentricity of the load [$$mm$$].
+            [$c_1$] Column dimension parallel to the eccentricity of the load [$mm$].
         c_2 : MM
-            [$$c_2$$] Column dimension perpendicular to the eccentricity of the load [$$mm$$].
+            [$c_2$] Column dimension perpendicular to the eccentricity of the load [$mm$].
         d : MM
-            [$$d$$] Mean effective depth of the slab [$$mm$$].
+            [$d$] Mean effective depth of the slab [$mm$].
         """
         super().__init__()
         self.c_1 = c_1

README.md

@@ -8,9 +8,9 @@
 
 
 <picture>
-  <source media="(prefers-color-scheme: dark)" srcset="docs/source/_static/blueprints_banner.png">
-  <source media="(prefers-color-scheme: light)" srcset="docs/source/_static/blueprints_banner.png">
-  <img alt="blueprints banner" src="docs/source/_static/blueprints_banner.png">
+  <source media="(prefers-color-scheme: dark)" srcset="docs/_overrides/assets/images/blueprints_banner.png">
+  <source media="(prefers-color-scheme: light)" srcset="docs/_overrides/assets/images/blueprints_banner.png">
+  <img alt="blueprints banner" src="docs/_overrides/assets/images/blueprints_banner.png">
 </picture>
 
 Welcome to `Blueprints`, the go-to repository for civil engineering professionals and enthusiasts!

blueprints/checks/nominal_concrete_cover/nominal_concrete_cover.py

@@ -28,15 +28,15 @@
 
 @dataclass(frozen=True)
 class NominalConcreteCover:
-    r"""Class responsible for the calculation of the nominal concrete cover [$$c_{nom}$$] [$$mm$$].
+    r"""Class responsible for the calculation of the nominal concrete cover [$c_{nom}$] [$mm$].
     It takes considerations of art.4.4.1.2 and 4.4.1.3 into account.
 
     Parameters
     ----------
     reinforcement_diameter: MM
-        The diameter of the reinforcement [$$mm$$].
+        The diameter of the reinforcement [$mm$].
     nominal_max_aggregate_size: MM
-        The nominal maximum aggregate size [$$mm$$].
+        The nominal maximum aggregate size [$mm$].
     constants: ConstantsBase
         The constants for the calculation of the nominal concrete cover.
     structural_class: ConcreteStructuralClassBase | int
@@ -49,16 +49,16 @@ class NominalConcreteCover:
     chloride_seawater: ChlorideSeawater | Literal["XS1", "XS2", "XS3", "NA"]
         The classification of corrosion induced by chlorides from sea water. Default is "Not applicable".
     delta_c_dur_gamma: MM
-        [$$\Delta c_{dur,\gamma}$$] An additional safety requirement based on art. 4.4.1.2 (6) [$$mm$$].
-        The value of [$$\Delta c_{dur,\gamma}$$] for use in a Country may be found in its National Annex.
+        [$\Delta c_{dur,\gamma}$] An additional safety requirement based on art. 4.4.1.2 (6) [$mm$].
+        The value of [$\Delta c_{dur,\gamma}$] for use in a Country may be found in its National Annex.
         The recommended value is 0 mm. 0 mm is the default value in the formula if not specified otherwise.
     delta_c_dur_st: MM
-        [$$\Delta c_{dur,st}$$] A reduction of minimum concrete cover when using stainless steel based on art. 4.4.1.2 (7) [$$mm$$].
-        The value of [$$\Delta c_{dur,st}$$] for use in a Country may be found in its National Annex.
+        [$\Delta c_{dur,st}$] A reduction of minimum concrete cover when using stainless steel based on art. 4.4.1.2 (7) [$mm$].
+        The value of [$\Delta c_{dur,st}$] for use in a Country may be found in its National Annex.
         The recommended value, without further specification, is 0 mm. 0 mm is the default value in the formula if not specified otherwise.
     delta_c_dur_add: MM
-        [$$\Delta c_{dur,add}$$] A reduction of minimum concrete cover when using additional protection based on art. 4.4.1.2 (8) [$$mm$$].
-        The value of [$$\Delta c_{dur,add}$$] for use in a Country may be found in its National Annex.
+        [$\Delta c_{dur,add}$] A reduction of minimum concrete cover when using additional protection based on art. 4.4.1.2 (8) [$mm$].
+        The value of [$\Delta c_{dur,add}$] for use in a Country may be found in its National Annex.
         The recommended value, without further specification, is 0 mm. 0 mm is the default value in the formula if not specified otherwise.
     casting_surface: CastingSurface
         The casting surface of the concrete according to art. 4.4.1.3 (4).

blueprints/codes/eurocode/nen_9997_1_c2_2017/chapter_1_general_rules/formula_1_0_1.py

@@ -10,22 +10,22 @@
 
 
 class Form1Dot0Dot1EquivalentPilePointCenterline(Formula):
-    r"""Class representing formula 1.0.1 for the calculation of the equivalent pile point centerline [$$D_{eq}$$] in [$$m$$]."""
+    r"""Class representing formula 1.0.1 for the calculation of the equivalent pile point centerline [$D_{eq}$] in [$m$]."""
 
     label = "1.0.1"
     source_document = NEN_9997_1_C2_2017
 
     def __init__(self, a: M, b: M) -> None:
-        r"""[$$D_{eq}$$] Equivalent pile point centerline.
+        r"""[$D_{eq}$] Equivalent pile point centerline.
 
         NEN 9997-1+C2:2017 art.1.5.2.106a - Formula (1.0.1)
 
         Parameters
         ----------
         a : M
-            [$$a$$] minor dimension of the largest cross-section at the pile tip [$$m$$].
+            [$a$] minor dimension of the largest cross-section at the pile tip [$m$].
         b : M
-            [$$b$$] major dimension of the largest cross-section at the pile tip [$$m$$].
+            [$b$] major dimension of the largest cross-section at the pile tip [$m$].
 
             Where: b ≤ 1.5 * a
         """

blueprints/codes/eurocode/nen_9997_1_c2_2017/chapter_2_basic_of_geotechnical_design/formula_2_1_a.py

@@ -8,22 +8,22 @@
 
 
 class Form2Dot1aDesignValueLoad(Formula):
-    """Class representing formula 2.1a for the calculation of the design value [$$F_{d}$$] of actions."""
+    """Class representing formula 2.1a for the calculation of the design value [$F_{d}$] of actions."""
 
     label = "2.1a"
     source_document = NEN_9997_1_C2_2017
 
     def __init__(self, gamma_f: DIMENSIONLESS, f_rep: DIMENSIONLESS) -> None:
-        r"""[$$F_{d}$$] Design value of actions.
+        r"""[$F_{d}$] Design value of actions.
 
         NEN 9997-1+C2:2017 art.2.4.6.1(2) - (Formula 2.1a)
 
         Parameters
         ----------
         gamma_f : DIMENSIONLESS
-            [$$\gamma_{F}$$] partial factor for actions for persistent and transient situations defined in annex A [$$-$$].
+            [$\gamma_{F}$] partial factor for actions for persistent and transient situations defined in annex A [$-$].
         f_rep : DIMENSIONLESS
-            [$$F_{rep}$$] Representative value of actions.
+            [$F_{rep}$] Representative value of actions.
 
             Use your own implementation for this value or use :class:`Form2Dot1bRepresentativeValue`.
         """

blueprints/codes/eurocode/nen_9997_1_c2_2017/chapter_2_basic_of_geotechnical_design/formula_2_1_b.py

@@ -8,22 +8,22 @@
 
 
 class Form2Dot1bRepresentativeValue(Formula):
-    """Class representing formula 2.1b for the calculation of the representative value [$$F_{rep}$$] of actions."""
+    """Class representing formula 2.1b for the calculation of the representative value [$F_{rep}$] of actions."""
 
     label = "2.1b"
     source_document = NEN_9997_1_C2_2017
 
     def __init__(self, psi: DIMENSIONLESS, f_k: DIMENSIONLESS) -> None:
-        r"""[$$F_{rep}$$] Representative value of actions.
+        r"""[$F_{rep}$] Representative value of actions.
 
         NEN 9997-1+C2:2017 art.2.4.6.1(2) - Formula (2.1b)
 
         Parameters
         ----------
         psi : DIMENSIONLESS
-            [$$\Psi$$] factor for converting the characteristic value to the representative value [$$-$$].
+            [$\Psi$] factor for converting the characteristic value to the representative value [$-$].
         f_k : DIMENSIONLESS
-            [$$F_{k}$$] Characteristic value of actions [$$-$$].
+            [$F_{k}$] Characteristic value of actions [$-$].
         """
         super().__init__()
         self.psi = psi

blueprints/codes/eurocode/nen_9997_1_c2_2017/chapter_2_basic_of_geotechnical_design/formula_2_2.py

@@ -8,22 +8,22 @@
 
 
 class Form2Dot2DesignValueGeotechnicalParameter(Formula):
-    """Class representing formula 2.2 for the calculation of the design value [$$X_d$$] of geotechnical parameter [$$X$$]."""
+    """Class representing formula 2.2 for the calculation of the design value [$X_d$] of geotechnical parameter [$X$]."""
 
     label = "2.2"
     source_document = NEN_9997_1_C2_2017
 
     def __init__(self, x_k: DIMENSIONLESS, gamma_m: DIMENSIONLESS) -> None:
-        r"""[$$X_d$$] Design value of geotechnical parameter [$$X$$].
+        r"""[$X_d$] Design value of geotechnical parameter [$X$].
 
         NEN 9997-1+C2:2017 art.2.4.6.2(1) - Formula (2.2)
 
         Parameters
         ----------
         x_k : DIMENSIONLESS
-            [$$X_{k}$$] Characteristic value of geotechnical parameter [$$X$$].
+            [$X_{k}$] Characteristic value of geotechnical parameter [$X$].
         gamma_m : DIMENSIONLESS
-            [$$\gamma_M$$] material partial factor [$$-$$].
+            [$\gamma_M$] material partial factor [$-$].
         """
         super().__init__()
         self.x_k = x_k

blueprints/codes/eurocode/nen_9997_1_c2_2017/chapter_2_basic_of_geotechnical_design/formula_2_4.py

@@ -12,7 +12,7 @@ class Form2Dot4DesignValueGeotechnicalParameter:
     r"""Class representing formula 2.4 for the check of
     the destabilizing load effect
     against the stabilizing load effect and friction resistance
-    [$$E_{dst;d} \leq E_{stb;d} + T_d$$].
+    [$E_{dst;d} \leq E_{stb;d} + T_d$].
     """
 
     label = "2.4"
@@ -21,18 +21,18 @@ class Form2Dot4DesignValueGeotechnicalParameter:
     def __init__(self, e_dst_d: KN, e_stb_d: KN, t_d: KN) -> None:
         r"""Check of the destabilizing load effect
         against the stabilizing load effect and friction resistance
-        [$$E_{dst;d} \leq E_{stb;d} + T_d$$].
+        [$E_{dst;d} \leq E_{stb;d} + T_d$].
 
         NEN 9997-1+C2:2017 art.2.4.7.2(1) - Formula (2.4)
 
         Parameters
         ----------
         E_dst_d : KN
-            [$$E_{dst;d}$$] Design value of destabilizing load effect [$$kN$$].
+            [$E_{dst;d}$] Design value of destabilizing load effect [$kN$].
         E_stb_d : KN
-            [$$E_{stb;d}$$] Design value of stabilizing load effect [$$kN$$].
+            [$E_{stb;d}$] Design value of stabilizing load effect [$kN$].
         T_d : KN
-            [$$T_d$$] Design value of friction resistance [$$kN$$].
+            [$T_d$] Design value of friction resistance [$kN$].
         """
         self.e_dst_d = e_dst_d
         self.e_stb_d = e_stb_d

blueprints/codes/eurocode/nen_en_1992_1_1_c2_2011/chapter_3_materials/formula_3_1.py

@@ -8,7 +8,7 @@
 
 
 class Form3Dot1EstimationConcreteCompressiveStrength(Formula):
-    r"""Class representing formula 3.1 for the estimation of the concrete compressive strength, [$$f_{cm}(t)$$], after t days
+    r"""Class representing formula 3.1 for the estimation of the concrete compressive strength, [$f_{cm}(t)$], after t days
     with an average temperature of 20 degrees Celsius.
     """
 
@@ -20,16 +20,16 @@ def __init__(
         beta_cc_t: DIMENSIONLESS,
         f_cm: MPA,
     ) -> None:
-        r"""[$$f_{cm}(t)$$] The estimated concrete compressive strength [$$MPa$$].
+        r"""[$f_{cm}(t)$] The estimated concrete compressive strength [$MPa$].
 
         NEN-EN 1992-1-1+C2:2011 art.3.1.2(6) - Formula (3.1)
 
         Parameters
         ----------
         beta_cc_t : DIMENSIONLESS
-            [$$\beta_{cc}(t)$$] Coefficient dependent of the age of concrete [$$-$$].
+            [$\beta_{cc}(t)$] Coefficient dependent of the age of concrete [$-$].
         f_cm : MPA
-            [$$f_{cm}$$] Average concrete compressive strength on day 28 based on table 3.1 [$$MPa$$].
+            [$f_{cm}$] Average concrete compressive strength on day 28 based on table 3.1 [$MPa$].
 
         Returns
         -------

blueprints/codes/eurocode/nen_en_1992_1_1_c2_2011/chapter_3_materials/formula_3_10.py

@@ -20,18 +20,18 @@ def __init__(
         t_s: DAYS,
         h_0: MM,
     ) -> None:
-        r"""[$$\beta_{ds}(t, t_s)$$] Coefficient for drying shrinkage due to age of concrete [$$-$$].
+        r"""[$\beta_{ds}(t, t_s)$] Coefficient for drying shrinkage due to age of concrete [$-$].
 
         NEN-EN 1992-1-1+C2:2011 art.3.1.4(6) - Formula (3.10)
 
         Parameters
         ----------
         t : DAYS
-            [$$t$$] Age in days of the concrete at the considered moment [$$days$$].
+            [$t$] Age in days of the concrete at the considered moment [$days$].
         t_s : DAYS
-            [$$t_s$$] Age in days of the concrete at the start of the drying shrinkage [$$days$$].
+            [$t_s$] Age in days of the concrete at the start of the drying shrinkage [$days$].
         h_0 : MM
-            [$$h_0$$] fictional thickness of cross-section [$$mm$$].
+            [$h_0$] fictional thickness of cross-section [$mm$].
             = 2 * Ac / u
             Use your own implementation of this formula or use the SubForm3Dot10FictionalCrossSection class.
 
@@ -83,16 +83,16 @@ def __init__(
         a_c: MM2,
         u: MM,
     ) -> None:
-        r"""[$$h_0$$] Fictional thickness of the cross-section [$$mm$$].
+        r"""[$h_0$] Fictional thickness of the cross-section [$mm$].
 
         NEN-EN 1992-1-1+C2:2011 art.3.1.4(6) - h0
 
         Parameters
         ----------
         a_c : MM2
-            [$$A_c$$] Area of the cross-section of the concrete [$$mm^2$$].
+            [$A_c$] Area of the cross-section of the concrete [$mm^2$].
         u : MM
-            [$$u$$] Circumference of part that is subjected to drying [$$mm$$].
+            [$u$] Circumference of part that is subjected to drying [$mm$].
         """
         super().__init__()
         self.a_c = a_c

blueprints/codes/eurocode/nen_en_1992_1_1_c2_2011/chapter_3_materials/formula_3_11.py

@@ -17,18 +17,18 @@ def __init__(
         beta_as_t: DIMENSIONLESS,
         epsilon_ca_inf: DIMENSIONLESS,
     ) -> None:
-        r"""[$$\epsilon_{ca}(t)$$] Autogene shrinkage [$$-$$].
+        r"""[$\epsilon_{ca}(t)$] Autogene shrinkage [$-$].
 
         NEN-EN 1992-1-1+C2:2011 art.3.1.4(6) - Formula (3.11)
 
         Parameters
         ----------
         beta_as_t : DIMENSIONLESS
-            [$$\beta_{as}(t)$$] Coefficient dependent on time in days for autogene shrinkage [$$-$$].
+            [$\beta_{as}(t)$] Coefficient dependent on time in days for autogene shrinkage [$-$].
             = 1 - exp(-0.2 * t^0.5)
             Use your own implementation of this formula or use the Form3Dot13CoefficientTimeAutogeneShrinkage class
         epsilon_ca_inf : DIMENSIONLESS
-            [$$\epsilon_{ca}(\infty)$$] Autogene shrinkage at infinity [$$-$$].
+            [$\epsilon_{ca}(\infty)$] Autogene shrinkage at infinity [$-$].
             = 2.5 * (fck - 10) E-6
             Use your own implementation of this formula or use the Form3Dot12AutogeneShrinkageInfinity class.
 

blueprints/codes/eurocode/nen_en_1992_1_1_c2_2011/chapter_3_materials/formula_3_12.py

@@ -16,14 +16,14 @@ def __init__(
         self,
         f_ck: MPA,
     ) -> None:
-        r"""[$$\epsilon_{ca}(\infty)$$] Autogene shrinkage at infinity [$$$$-].
+        r"""[$\epsilon_{ca}(\infty)$] Autogene shrinkage at infinity [$$-].
 
         NEN-EN 1992-1-1+C2:2011 art.3.1.4(6) - Formula (3.12)
 
         Parameters
         ----------
         f_ck : MPA
-            [$$f_{ck}$$] Compressive strength concrete [$$MPa$$].
+            [$f_{ck}$] Compressive strength concrete [$MPa$].
 
         Returns
         -------

blueprints/codes/eurocode/nen_en_1992_1_1_c2_2011/chapter_3_materials/formula_3_13.py

@@ -18,14 +18,14 @@ def __init__(
         self,
         t: DAYS,
     ) -> None:
-        r"""[$$\beta_{as}(t)$$] Coefficient dependent on time in days for autogene shrinkage [$$-$$].
+        r"""[$\beta_{as}(t)$] Coefficient dependent on time in days for autogene shrinkage [$-$].
 
         NEN-EN 1992-1-1+C2:2011 art.3.1.4(6) - Formula (3.13)
 
         Parameters
         ----------
         t : DAYS
-            [$$t$$] Time in days [$$days$$].
+            [$t$] Time in days [$days$].
 
         Returns
         -------