Deploy to GitHub pages

BlockResearchGroup · Nov 10, 2024 · 468b7ef · 468b7ef
1 parent c9776ec
commit 468b7ef
Show file tree

Hide file tree

Showing 25 changed files with 121 additions and 57 deletions.
diff --git a/latest/api/generated/compas_fd.constraints.CircleConstraint.copy.html b/latest/api/generated/compas_fd.constraints.CircleConstraint.copy.html
@@ -555,14 +555,16 @@
 <h1>CircleConstraint.copy</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fd.constraints.CircleConstraint.copy">
-<span class="sig-prename descclassname"><span class="pre">CircleConstraint.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">CircleConstraint.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy_guid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Make an independent copy of the data object.</p>
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl>
 <dt><strong>cls</strong><span class="classifier">Type[<a class="reference external" href="https://compas.dev/compas/latest/api/generated/compas.data.Data.html" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">compas.data.Data</span></code></a>], optional</span></dt><dd><p>The type of data object to return.
 Defaults to the type of the current data object.</p>
 </dd>
+<dt><strong>copy_guid</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, the copy will have the same guid as the original.</p>
+</dd>
 </dl>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>

diff --git a/latest/api/generated/compas_fd.constraints.CircleConstraint.to_json.html b/latest/api/generated/compas_fd.constraints.CircleConstraint.to_json.html
@@ -555,15 +555,18 @@
 <h1>CircleConstraint.to_json</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fd.constraints.CircleConstraint.to_json">
-<span class="sig-prename descclassname"><span class="pre">CircleConstraint.</span></span><span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">CircleConstraint.</span></span><span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minimal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Convert an object to its native data representation and save it to a JSON file.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl class="simple">
 <dt><strong>filepath</strong><span class="classifier">str</span></dt><dd><p>The path to the JSON file.</p>
 </dd>
-<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, the JSON file will be pretty printed.
-Defaults to False.</p>
+<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output with newlines and indentation.</p>
+</dd>
+<dt><strong>compact</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output without any whitespace.</p>
+</dd>
+<dt><strong>minimal</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, exclude the GUID from the JSON output.</p>
 </dd>
 </dl>
 </dd>

diff --git a/latest/api/generated/compas_fd.constraints.CircleConstraint.to_jsonstring.html b/latest/api/generated/compas_fd.constraints.CircleConstraint.to_jsonstring.html
@@ -555,13 +555,16 @@
 <h1>CircleConstraint.to_jsonstring</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fd.constraints.CircleConstraint.to_jsonstring">
-<span class="sig-prename descclassname"><span class="pre">CircleConstraint.</span></span><span class="sig-name descname"><span class="pre">to_jsonstring</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">CircleConstraint.</span></span><span class="sig-name descname"><span class="pre">to_jsonstring</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minimal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Convert an object to its native data representation and save it to a JSON string.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl class="simple">
-<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, the JSON string will be pretty printed.
-Defaults to False.</p>
+<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output with newlines and indentation.</p>
+</dd>
+<dt><strong>compact</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output without any whitespace.</p>
+</dd>
+<dt><strong>minimal</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, exclude the GUID from the JSON output.</p>
 </dd>
 </dl>
 </dd>

diff --git a/latest/api/generated/compas_fd.constraints.Constraint.copy.html b/latest/api/generated/compas_fd.constraints.Constraint.copy.html
@@ -555,14 +555,16 @@
 <h1>Constraint.copy</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fd.constraints.Constraint.copy">
-<span class="sig-prename descclassname"><span class="pre">Constraint.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">Constraint.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy_guid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Make an independent copy of the data object.</p>
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl>
 <dt><strong>cls</strong><span class="classifier">Type[<a class="reference external" href="https://compas.dev/compas/latest/api/generated/compas.data.Data.html" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">compas.data.Data</span></code></a>], optional</span></dt><dd><p>The type of data object to return.
 Defaults to the type of the current data object.</p>
 </dd>
+<dt><strong>copy_guid</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, the copy will have the same guid as the original.</p>
+</dd>
 </dl>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>

diff --git a/latest/api/generated/compas_fd.constraints.Constraint.to_json.html b/latest/api/generated/compas_fd.constraints.Constraint.to_json.html
@@ -555,15 +555,18 @@
 <h1>Constraint.to_json</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fd.constraints.Constraint.to_json">
-<span class="sig-prename descclassname"><span class="pre">Constraint.</span></span><span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">Constraint.</span></span><span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minimal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Convert an object to its native data representation and save it to a JSON file.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl class="simple">
 <dt><strong>filepath</strong><span class="classifier">str</span></dt><dd><p>The path to the JSON file.</p>
 </dd>
-<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, the JSON file will be pretty printed.
-Defaults to False.</p>
+<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output with newlines and indentation.</p>
+</dd>
+<dt><strong>compact</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output without any whitespace.</p>
+</dd>
+<dt><strong>minimal</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, exclude the GUID from the JSON output.</p>
 </dd>
 </dl>
 </dd>

diff --git a/latest/api/generated/compas_fd.constraints.Constraint.to_jsonstring.html b/latest/api/generated/compas_fd.constraints.Constraint.to_jsonstring.html
@@ -555,13 +555,16 @@
 <h1>Constraint.to_jsonstring</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fd.constraints.Constraint.to_jsonstring">
-<span class="sig-prename descclassname"><span class="pre">Constraint.</span></span><span class="sig-name descname"><span class="pre">to_jsonstring</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">Constraint.</span></span><span class="sig-name descname"><span class="pre">to_jsonstring</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minimal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Convert an object to its native data representation and save it to a JSON string.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl class="simple">
-<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, the JSON string will be pretty printed.
-Defaults to False.</p>
+<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output with newlines and indentation.</p>
+</dd>
+<dt><strong>compact</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output without any whitespace.</p>
+</dd>
+<dt><strong>minimal</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, exclude the GUID from the JSON output.</p>
 </dd>
 </dl>
 </dd>

diff --git a/latest/api/generated/compas_fd.constraints.CurveConstraint.copy.html b/latest/api/generated/compas_fd.constraints.CurveConstraint.copy.html
@@ -555,14 +555,16 @@
 <h1>CurveConstraint.copy</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fd.constraints.CurveConstraint.copy">
-<span class="sig-prename descclassname"><span class="pre">CurveConstraint.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">CurveConstraint.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy_guid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Make an independent copy of the data object.</p>
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl>
 <dt><strong>cls</strong><span class="classifier">Type[<a class="reference external" href="https://compas.dev/compas/latest/api/generated/compas.data.Data.html" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">compas.data.Data</span></code></a>], optional</span></dt><dd><p>The type of data object to return.
 Defaults to the type of the current data object.</p>
 </dd>
+<dt><strong>copy_guid</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, the copy will have the same guid as the original.</p>
+</dd>
 </dl>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>

diff --git a/latest/api/generated/compas_fd.constraints.CurveConstraint.to_json.html b/latest/api/generated/compas_fd.constraints.CurveConstraint.to_json.html
@@ -555,15 +555,18 @@
 <h1>CurveConstraint.to_json</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_fd.constraints.CurveConstraint.to_json">
-<span class="sig-prename descclassname"><span class="pre">CurveConstraint.</span></span><span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">CurveConstraint.</span></span><span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pretty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minimal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
 <dd><p>Convert an object to its native data representation and save it to a JSON file.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><dl class="simple">
 <dt><strong>filepath</strong><span class="classifier">str</span></dt><dd><p>The path to the JSON file.</p>
 </dd>
-<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, the JSON file will be pretty printed.
-Defaults to False.</p>
+<dt><strong>pretty</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output with newlines and indentation.</p>
+</dd>
+<dt><strong>compact</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, format the output without any whitespace.</p>
+</dd>
+<dt><strong>minimal</strong><span class="classifier">bool, optional</span></dt><dd><p>If True, exclude the GUID from the JSON output.</p>
 </dd>
 </dl>
 </dd>