Updated following changes in #342-PyMaterialXCore-class-docstrings.

Signed-off-by: Stefan Habel <[email protected]>

generated/PyMaterialXCore.AttributeDef.html

@@ -39,6 +39,12 @@ <h1>PyMaterialXCore.AttributeDef<a class="headerlink" href="#pymaterialxcore-att
 <dt class="sig sig-object py" id="PyMaterialXCore.AttributeDef">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AttributeDef</span></span><a class="headerlink" href="#PyMaterialXCore.AttributeDef" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="PyMaterialXCore.TypedElement.html#PyMaterialXCore.TypedElement" title="PyMaterialXCore.TypedElement"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypedElement</span></code></a></p>
+<p>An attribute definition element within a <a class="reference internal" href="PyMaterialXCore.Document.html#PyMaterialXCore.Document" title="PyMaterialXCore.Document"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Document</span></code></a>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">See<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://materialx.org/docs/api/class_attribute_def.html">https://materialx.org/docs/api/class_attribute_def.html</a></p>
+</dd>
+</dl>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

generated/PyMaterialXCore.Backdrop.html

@@ -39,6 +39,12 @@ <h1>PyMaterialXCore.Backdrop<a class="headerlink" href="#pymaterialxcore-backdro
 <dt class="sig sig-object py" id="PyMaterialXCore.Backdrop">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Backdrop</span></span><a class="headerlink" href="#PyMaterialXCore.Backdrop" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="PyMaterialXCore.Element.html#PyMaterialXCore.Element" title="PyMaterialXCore.Element"><code class="xref py py-class docutils literal notranslate"><span class="pre">Element</span></code></a></p>
+<p>A layout element used to contain, group, and document nodes within a graph.</p>
+<dl class="field-list simple">
+<dt class="field-odd">See<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://materialx.org/docs/api/class_backdrop.html">https://materialx.org/docs/api/class_backdrop.html</a></p>
+</dd>
+</dl>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

generated/PyMaterialXCore.Collection.html

@@ -39,6 +39,12 @@ <h1>PyMaterialXCore.Collection<a class="headerlink" href="#pymaterialxcore-colle
 <dt class="sig sig-object py" id="PyMaterialXCore.Collection">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Collection</span></span><a class="headerlink" href="#PyMaterialXCore.Collection" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="PyMaterialXCore.Element.html#PyMaterialXCore.Element" title="PyMaterialXCore.Element"><code class="xref py py-class docutils literal notranslate"><span class="pre">Element</span></code></a></p>
+<p>A collection element within a <a class="reference internal" href="PyMaterialXCore.Document.html#PyMaterialXCore.Document" title="PyMaterialXCore.Document"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Document</span></code></a>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">See<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://materialx.org/docs/api/class_collection.html">https://materialx.org/docs/api/class_collection.html</a></p>
+</dd>
+</dl>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

generated/PyMaterialXCore.Color3.html

@@ -39,6 +39,12 @@ <h1>PyMaterialXCore.Color3<a class="headerlink" href="#pymaterialxcore-color3" t
 <dt class="sig sig-object py" id="PyMaterialXCore.Color3">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Color3</span></span><a class="headerlink" href="#PyMaterialXCore.Color3" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="PyMaterialXCore.VectorBase.html#PyMaterialXCore.VectorBase" title="PyMaterialXCore.VectorBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">VectorBase</span></code></a></p>
+<p>A three-component RGB color value.</p>
+<dl class="field-list simple">
+<dt class="field-odd">See<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://materialx.org/docs/api/class_color3.html">https://materialx.org/docs/api/class_color3.html</a></p>
+</dd>
+</dl>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

generated/PyMaterialXCore.Color4.html

@@ -39,6 +39,12 @@ <h1>PyMaterialXCore.Color4<a class="headerlink" href="#pymaterialxcore-color4" t
 <dt class="sig sig-object py" id="PyMaterialXCore.Color4">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Color4</span></span><a class="headerlink" href="#PyMaterialXCore.Color4" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="PyMaterialXCore.VectorBase.html#PyMaterialXCore.VectorBase" title="PyMaterialXCore.VectorBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">VectorBase</span></code></a></p>
+<p>A four-component RGBA color value.</p>
+<dl class="field-list simple">
+<dt class="field-odd">See<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://materialx.org/docs/api/class_color4.html">https://materialx.org/docs/api/class_color4.html</a></p>
+</dd>
+</dl>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

generated/PyMaterialXCore.CommentElement.html

@@ -39,6 +39,15 @@ <h1>PyMaterialXCore.CommentElement<a class="headerlink" href="#pymaterialxcore-c
 <dt class="sig sig-object py" id="PyMaterialXCore.CommentElement">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CommentElement</span></span><a class="headerlink" href="#PyMaterialXCore.CommentElement" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="PyMaterialXCore.Element.html#PyMaterialXCore.Element" title="PyMaterialXCore.Element"><code class="xref py py-class docutils literal notranslate"><span class="pre">Element</span></code></a></p>
+<p>An element representing a block of descriptive text within a <a class="reference internal" href="PyMaterialXCore.Document.html#PyMaterialXCore.Document" title="PyMaterialXCore.Document"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Document</span></code></a>,
+which will be stored as a comment when the document is written out.</p>
+<p>The comment text may be accessed with the methods <a class="reference internal" href="PyMaterialXCore.Element.html#PyMaterialXCore.Element.getDocString" title="PyMaterialXCore.Element.getDocString"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Element.getDocString()</span></code></a>
+and <a class="reference internal" href="PyMaterialXCore.Element.html#PyMaterialXCore.Element.setDocString" title="PyMaterialXCore.Element.setDocString"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Element.setDocString()</span></code></a>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">See<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://materialx.org/docs/api/class_comment_element.html">https://materialx.org/docs/api/class_comment_element.html</a></p>
+</dd>
+</dl>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

generated/PyMaterialXCore.Document.html

@@ -39,6 +39,13 @@ <h1>PyMaterialXCore.Document<a class="headerlink" href="#pymaterialxcore-documen
 <dt class="sig sig-object py" id="PyMaterialXCore.Document">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Document</span></span><a class="headerlink" href="#PyMaterialXCore.Document" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="PyMaterialXCore.GraphElement.html#PyMaterialXCore.GraphElement" title="PyMaterialXCore.GraphElement"><code class="xref py py-class docutils literal notranslate"><span class="pre">GraphElement</span></code></a></p>
+<p>A MaterialX document, which represents the top-level element in the MaterialX ownership hierarchy.</p>
+<p>Use the factory function <a class="reference internal" href="PyMaterialXCore.html#PyMaterialXCore.createDocument" title="PyMaterialXCore.createDocument"><code class="xref py py-obj docutils literal notranslate"><span class="pre">createDocument()</span></code></a> to create a <a class="reference internal" href="#PyMaterialXCore.Document" title="PyMaterialXCore.Document"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Document</span></code></a> instance.</p>
+<dl class="field-list simple">
+<dt class="field-odd">See<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://materialx.org/docs/api/class_document.html">https://materialx.org/docs/api/class_document.html</a></p>
+</dd>
+</dl>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

generated/PyMaterialXCore.Edge.html

@@ -39,6 +39,19 @@ <h1>PyMaterialXCore.Edge<a class="headerlink" href="#pymaterialxcore-edge" title
 <dt class="sig sig-object py" id="PyMaterialXCore.Edge">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Edge</span></span><a class="headerlink" href="#PyMaterialXCore.Edge" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pybind11_object</span></code></p>
+<p>An edge between two connected <a class="reference internal" href="PyMaterialXCore.Element.html#PyMaterialXCore.Element" title="PyMaterialXCore.Element"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Element</span></code></a> objects, returned during graph traversal.</p>
+<p>A valid <a class="reference internal" href="#PyMaterialXCore.Edge" title="PyMaterialXCore.Edge"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Edge</span></code></a> consists of a downstream element, an upstream element, and
+optionally a connecting element that binds them.  As an example, the edge
+between two <a class="reference internal" href="PyMaterialXCore.Node.html#PyMaterialXCore.Node" title="PyMaterialXCore.Node"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Node</span></code></a> elements will contain a connecting element for the <a class="reference internal" href="PyMaterialXCore.Input.html#PyMaterialXCore.Input" title="PyMaterialXCore.Input"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Input</span></code></a>
+of the downstream <a class="reference internal" href="PyMaterialXCore.Node.html#PyMaterialXCore.Node" title="PyMaterialXCore.Node"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Node</span></code></a>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">See<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference internal" href="PyMaterialXCore.Element.html#PyMaterialXCore.Element.traverseGraph" title="PyMaterialXCore.Element.traverseGraph"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Element.traverseGraph()</span></code></a></p>
+</dd>
+<dt class="field-even">See<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference external" href="https://materialx.org/docs/api/class_edge.html">https://materialx.org/docs/api/class_edge.html</a></p>
+</dd>
+</dl>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

generated/PyMaterialXCore.Element.html

@@ -39,6 +39,18 @@ <h1>PyMaterialXCore.Element<a class="headerlink" href="#pymaterialxcore-element"
 <dt class="sig sig-object py" id="PyMaterialXCore.Element">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Element</span></span><a class="headerlink" href="#PyMaterialXCore.Element" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pybind11_object</span></code></p>
+<p>The base class for MaterialX elements.</p>
+<p>An <a class="reference internal" href="#PyMaterialXCore.Element" title="PyMaterialXCore.Element"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Element</span></code></a> is a named object within a <a class="reference internal" href="PyMaterialXCore.Document.html#PyMaterialXCore.Document" title="PyMaterialXCore.Document"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Document</span></code></a>, which may possess any
+number of child elements and attributes.</p>
+<p>Inherited by: <a class="reference internal" href="PyMaterialXCore.TypedElement.html#PyMaterialXCore.TypedElement" title="PyMaterialXCore.TypedElement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TypedElement</span></code></a>, <a class="reference internal" href="PyMaterialXCore.GeomElement.html#PyMaterialXCore.GeomElement" title="PyMaterialXCore.GeomElement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GeomElement</span></code></a>, <a class="reference internal" href="PyMaterialXCore.Backdrop.html#PyMaterialXCore.Backdrop" title="PyMaterialXCore.Backdrop"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Backdrop</span></code></a>, <a class="reference internal" href="PyMaterialXCore.Collection.html#PyMaterialXCore.Collection" title="PyMaterialXCore.Collection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Collection</span></code></a>,
+<a class="reference internal" href="PyMaterialXCore.CommentElement.html#PyMaterialXCore.CommentElement" title="PyMaterialXCore.CommentElement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CommentElement</span></code></a>, <a class="reference internal" href="PyMaterialXCore.GenericElement.html#PyMaterialXCore.GenericElement" title="PyMaterialXCore.GenericElement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GenericElement</span></code></a>, <a class="reference internal" href="PyMaterialXCore.Look.html#PyMaterialXCore.Look" title="PyMaterialXCore.Look"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Look</span></code></a>, <a class="reference internal" href="PyMaterialXCore.LookGroup.html#PyMaterialXCore.LookGroup" title="PyMaterialXCore.LookGroup"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LookGroup</span></code></a>, <a class="reference internal" href="PyMaterialXCore.NewlineElement.html#PyMaterialXCore.NewlineElement" title="PyMaterialXCore.NewlineElement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NewlineElement</span></code></a>,
+<a class="reference internal" href="PyMaterialXCore.PropertySet.html#PyMaterialXCore.PropertySet" title="PyMaterialXCore.PropertySet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PropertySet</span></code></a>, <a class="reference internal" href="PyMaterialXCore.TypeDef.html#PyMaterialXCore.TypeDef" title="PyMaterialXCore.TypeDef"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TypeDef</span></code></a>, <a class="reference internal" href="PyMaterialXCore.Unit.html#PyMaterialXCore.Unit" title="PyMaterialXCore.Unit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Unit</span></code></a>, <a class="reference internal" href="PyMaterialXCore.UnitDef.html#PyMaterialXCore.UnitDef" title="PyMaterialXCore.UnitDef"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnitDef</span></code></a>, <a class="reference internal" href="PyMaterialXCore.UnitTypeDef.html#PyMaterialXCore.UnitTypeDef" title="PyMaterialXCore.UnitTypeDef"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnitTypeDef</span></code></a>, <a class="reference internal" href="PyMaterialXCore.VariantSet.html#PyMaterialXCore.VariantSet" title="PyMaterialXCore.VariantSet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">VariantSet</span></code></a>,
+and <a class="reference internal" href="PyMaterialXCore.VariantAssign.html#PyMaterialXCore.VariantAssign" title="PyMaterialXCore.VariantAssign"><code class="xref py py-obj docutils literal notranslate"><span class="pre">VariantAssign</span></code></a>.</p>
+<dl class="field-list simple">
+<dt class="field-odd">See<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://materialx.org/docs/api/class_element.html">https://materialx.org/docs/api/class_element.html</a></p>
+</dd>
+</dl>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

generated/PyMaterialXCore.ElementPredicate.html

@@ -39,6 +39,8 @@ <h1>PyMaterialXCore.ElementPredicate<a class="headerlink" href="#pymaterialxcore
 <dt class="sig sig-object py" id="PyMaterialXCore.ElementPredicate">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ElementPredicate</span></span><a class="headerlink" href="#PyMaterialXCore.ElementPredicate" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pybind11_object</span></code></p>
+<p>A function that takes an <a class="reference internal" href="PyMaterialXCore.Element.html#PyMaterialXCore.Element" title="PyMaterialXCore.Element"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Element</span></code></a> and returns a <code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>,
+to check whether some criteria has passed.</p>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

generated/PyMaterialXCore.Exception.html

@@ -39,6 +39,13 @@ <h1>PyMaterialXCore.Exception<a class="headerlink" href="#pymaterialxcore-except
 <dt class="sig sig-object py" id="PyMaterialXCore.Exception">
 <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Exception</span></span><a class="headerlink" href="#PyMaterialXCore.Exception" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#PyMaterialXCore.Exception" title="PyMaterialXCore.Exception"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
+<p>The base class for exceptions that are propagated from the MaterialX
+library to the client application.</p>
+<dl class="field-list simple">
+<dt class="field-odd">See<span class="colon">:</span></dt>
+<dd class="field-odd"><p><a class="reference external" href="https://materialx.org/docs/api/class_exception.html">https://materialx.org/docs/api/class_exception.html</a></p>
+</dd>
+</dl>
 </dd></dl>
 
 </section>