Deploy to GitHub pages

pull_138/api/generated/compas_timber.assembly.TimberAssembly.add_connection.html

@@ -106,8 +106,8 @@ <h1>TimberAssembly.add_connection</h1>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>a</strong> (<a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.datastructures.Part.html#compas.datastructures.Part" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code></a>) – The “from” part.</p></li>
-<li><p><strong>b</strong> (<a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.datastructures.Part.html#compas.datastructures.Part" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code></a>) – The “to” part.</p></li>
+<li><p><strong>a</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code>) – The “from” part.</p></li>
+<li><p><strong>b</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code>) – The “to” part.</p></li>
 <li><p><strong>**kwargs</strong> (<em>dict[str, Any], optional</em>) – Attribute dict compiled from named arguments.</p></li>
 </ul>
 </dd>

pull_138/api/generated/compas_timber.assembly.TimberAssembly.add_part.html

@@ -106,7 +106,7 @@ <h1>TimberAssembly.add_part</h1>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>part</strong> (<a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.datastructures.Part.html#compas.datastructures.Part" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code></a>) – The part to add.</p></li>
+<li><p><strong>part</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code>) – The part to add.</p></li>
 <li><p><strong>key</strong> (<em>int | str, optional</em>) – The identifier of the part in the assembly.
 Note that the key is unique only in the context of the current assembly.
 Nested assemblies may have the same <cite>key</cite> value for one of their parts.

pull_138/api/generated/compas_timber.assembly.TimberAssembly.contains.html

@@ -105,7 +105,7 @@ <h1>TimberAssembly.contains</h1>
 <dd><p>Returns True if this assembly contains the given object, False otherwise.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>obj</strong> (<a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a>) – The object to look for.</p>
+<dd class="field-odd"><p><strong>obj</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code>) – The object to look for.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p><em>bool</em></p>

pull_138/api/generated/compas_timber.assembly.TimberAssembly.copy.html

@@ -105,11 +105,11 @@ <h1>TimberAssembly.copy</h1>
 <dd><p>Make an independent copy of the data object.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>cls</strong> (Type[<a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a>], optional) – The type of data object to return.
+<dd class="field-odd"><p><strong>cls</strong> (Type[<code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code>], optional) – The type of data object to return.
 Defaults to the type of the current data object.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a> – An independent copy of this object.</p>
+<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code> – An independent copy of this object.</p>
 </dd>
 </dl>
 </dd></dl>

pull_138/api/generated/compas_timber.assembly.TimberAssembly.find.html

@@ -109,7 +109,7 @@ <h1>TimberAssembly.find</h1>
 This identifier is automatically assigned when parts are created.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.datastructures.Part.html#compas.datastructures.Part" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code></a> | None – The identified part,
+<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code> | None – The identified part,
 or None if the part can’t be found.</p>
 </dd>
 </dl>

pull_138/api/generated/compas_timber.assembly.TimberAssembly.find_by_key.html

@@ -108,7 +108,7 @@ <h1>TimberAssembly.find_by_key</h1>
 <dd class="field-odd"><p><strong>key</strong> (<em>int | str, optional</em>) – The identifier of the part in the assembly.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.datastructures.Part.html#compas.datastructures.Part" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code></a> | None – The identified part,
+<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code> | None – The identified part,
 or None if the part can’t be found.</p>
 </dd>
 </dl>

pull_138/api/generated/compas_timber.assembly.TimberAssembly.from_data.html

@@ -108,7 +108,7 @@ <h1>TimberAssembly.from_data</h1>
 <dd class="field-odd"><p><strong>data</strong> (<em>dict</em>) – The data dictionary.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a> – An instance of this object type if the data contained in the dict has the correct schema.</p>
+<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code> – An instance of this object type if the data contained in the dict has the correct schema.</p>
 </dd>
 </dl>
 </dd></dl>

pull_138/api/generated/compas_timber.assembly.TimberAssembly.html

@@ -100,7 +100,7 @@ <h1>TimberAssembly</h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="compas_timber.assembly.TimberAssembly">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_timber.assembly.</span></span><span class="sig-name descname"><span class="pre">TimberAssembly</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/main/src/compas_timber/assembly/assembly.py#L8"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
-<dd><p>Bases: <a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.datastructures.Assembly.html#compas.datastructures.Assembly" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Assembly</span></code></a></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Assembly</span></code></p>
 <p>Represents a timber assembly containing beams and joints etc.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Attributes<span class="colon">:</span></dt>

pull_138/api/generated/compas_timber.assembly.TimberAssembly.parts.html

@@ -105,7 +105,7 @@ <h1>TimberAssembly.parts</h1>
 <dd><p>The parts of the assembly.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Yields<span class="colon">:</span></dt>
-<dd class="field-odd"><p><a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.datastructures.Part.html#compas.datastructures.Part" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code></a> – The individual parts of the assembly.</p>
+<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Part</span></code> – The individual parts of the assembly.</p>
 </dd>
 </dl>
 </dd></dl>

pull_138/api/generated/compas_timber.connections.Joint.add_features.html

@@ -101,7 +101,7 @@
 <h1>Joint.add_features</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_timber.connections.Joint.add_features">
-<span class="sig-prename descclassname"><span class="pre">Joint.</span></span><span class="sig-name descname"><span class="pre">add_features</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/main/src/compas_timber/connections/joint.py#L77"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">Joint.</span></span><span class="sig-name descname"><span class="pre">add_features</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/main/src/compas_timber/connections/joint.py#L79"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Adds the features defined by this joint to affected beam(s).</p>
 </dd></dl>
 

pull_138/api/generated/compas_timber.connections.Joint.copy.html

@@ -105,11 +105,11 @@ <h1>Joint.copy</h1>
 <dd><p>Make an independent copy of the data object.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>cls</strong> (Type[<a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a>], optional) – The type of data object to return.
+<dd class="field-odd"><p><strong>cls</strong> (Type[<code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code>], optional) – The type of data object to return.
 Defaults to the type of the current data object.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a> – An independent copy of this object.</p>
+<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code> – An independent copy of this object.</p>
 </dd>
 </dl>
 </dd></dl>

pull_138/api/generated/compas_timber.connections.Joint.from_data.html

@@ -108,7 +108,7 @@ <h1>Joint.from_data</h1>
 <dd class="field-odd"><p><strong>data</strong> (<em>dict</em>) – The data dictionary.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a> – An instance of this object type if the data contained in the dict has the correct schema.</p>
+<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code> – An instance of this object type if the data contained in the dict has the correct schema.</p>
 </dd>
 </dl>
 </dd></dl>

pull_138/api/generated/compas_timber.connections.Joint.html

@@ -100,13 +100,16 @@ <h1>Joint</h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="compas_timber.connections.Joint">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_timber.connections.</span></span><span class="sig-name descname"><span class="pre">Joint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">frame</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">key</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><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/main/src/compas_timber/connections/joint.py#L49"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
-<dd><p>Bases: <a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a></p>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></p>
 <p>Base class for a joint connecting two beams.</p>
 <p>This is a base class and should not be instantiated directly.
 Use the <cite>create()</cite> class method of the respective implementation of <cite>Joint</cite> instead.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Attributes<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>beams</strong> (list(<a class="reference internal" href="compas_timber.parts.Beam.html#compas_timber.parts.Beam" title="compas_timber.parts.Beam"><code class="xref py py-class docutils literal notranslate"><span class="pre">Beam</span></code></a>)) – The beams joined by this joint.</p>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>beams</strong> (list(<a class="reference internal" href="compas_timber.parts.Beam.html#compas_timber.parts.Beam" title="compas_timber.parts.Beam"><code class="xref py py-class docutils literal notranslate"><span class="pre">Beam</span></code></a>)) – The beams joined by this joint.</p></li>
+<li><p><strong>ends</strong> (dict(<a class="reference internal" href="compas_timber.parts.Beam.html#compas_timber.parts.Beam" title="compas_timber.parts.Beam"><code class="xref py py-class docutils literal notranslate"><span class="pre">Beam</span></code></a>, str)) – A map of which end of each beam is joined by this joint.</p></li>
+</ul>
 </dd>
 </dl>
 <p class="rubric">Methods</p>

pull_138/api/generated/compas_timber.connections.Joint.restore_beams_from_keys.html

@@ -101,7 +101,7 @@
 <h1>Joint.restore_beams_from_keys</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_timber.connections.Joint.restore_beams_from_keys">
-<span class="sig-prename descclassname"><span class="pre">Joint.</span></span><span class="sig-name descname"><span class="pre">restore_beams_from_keys</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/main/src/compas_timber/connections/joint.py#L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">Joint.</span></span><span class="sig-name descname"><span class="pre">restore_beams_from_keys</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/main/src/compas_timber/connections/joint.py#L83"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Restores the reference to the beams associate with this joint.</p>
 <p>During serialization, <a class="reference internal" href="compas_timber.parts.Beam.html#compas_timber.parts.Beam" title="compas_timber.parts.Beam"><code class="xref py py-class docutils literal notranslate"><span class="pre">compas_timber.parts.Beam</span></code></a> objects
 are serialized by <a class="reference internal" href="../compas_timber.assembly.html#module-compas_timber.assembly" title="compas_timber.assembly"><code class="xref py py-class docutils literal notranslate"><span class="pre">compas_timber.assembly</span></code></a>. To avoid circular references, Joint only stores the keys

pull_138/api/generated/compas_timber.connections.LButtJoint.copy.html

@@ -105,11 +105,11 @@ <h1>LButtJoint.copy</h1>
 <dd><p>Make an independent copy of the data object.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>cls</strong> (Type[<a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a>], optional) – The type of data object to return.
+<dd class="field-odd"><p><strong>cls</strong> (Type[<code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code>], optional) – The type of data object to return.
 Defaults to the type of the current data object.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a> – An independent copy of this object.</p>
+<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code> – An independent copy of this object.</p>
 </dd>
 </dl>
 </dd></dl>

pull_138/api/generated/compas_timber.connections.LButtJoint.from_data.html

@@ -108,7 +108,7 @@ <h1>LButtJoint.from_data</h1>
 <dd class="field-odd"><p><strong>data</strong> (<em>dict</em>) – The data dictionary.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://compas.dev/compas/latest/reference/generated/compas.data.Data.html#compas.data.Data" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a> – An instance of this object type if the data contained in the dict has the correct schema.</p>
+<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code> – An instance of this object type if the data contained in the dict has the correct schema.</p>
 </dd>
 </dl>
 </dd></dl>