Updated based on #342-PythonAPI-docs with branches for the related PR…

…s merged in. - AcademySoftwareFoundation/MaterialX#2038 - AcademySoftwareFoundation/MaterialX#2051 - AcademySoftwareFoundation/MaterialX#2061 - AcademySoftwareFoundation/MaterialX#2063 - AcademySoftwareFoundation/MaterialX#2064 - AcademySoftwareFoundation/MaterialX#2065 - AcademySoftwareFoundation/MaterialX#2066 Signed-off-by: Stefan Habel <[email protected]>
StefanHabel · Oct 14, 2024 · 217dbaf · 217dbaf
1 parent 165296c
commit 217dbaf
Show file tree

Hide file tree

Showing 80 changed files with 658 additions and 242 deletions.
diff --git a/generated/PyMaterialXCore.ElementEquivalenceOptions.html b/generated/PyMaterialXCore.ElementEquivalenceOptions.html
@@ -58,26 +58,22 @@ <h2>Properties<a class="headerlink" href="#properties" title="Link to this headi
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXCore.ElementEquivalenceOptions.format">
 <span class="sig-name descname"><span class="pre">format</span></span><a class="headerlink" href="#PyMaterialXCore.ElementEquivalenceOptions.format" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXCore.ElementEquivalenceOptions.format</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXCore.ElementEquivalenceOptions.precision">
 <span class="sig-name descname"><span class="pre">precision</span></span><a class="headerlink" href="#PyMaterialXCore.ElementEquivalenceOptions.precision" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXCore.ElementEquivalenceOptions.precision</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXCore.ElementEquivalenceOptions.skipAttributes">
 <span class="sig-name descname"><span class="pre">skipAttributes</span></span><a class="headerlink" href="#PyMaterialXCore.ElementEquivalenceOptions.skipAttributes" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXCore.ElementEquivalenceOptions.skipAttributes</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXCore.ElementEquivalenceOptions.skipValueComparisons">
 <span class="sig-name descname"><span class="pre">skipValueComparisons</span></span><a class="headerlink" href="#PyMaterialXCore.ElementEquivalenceOptions.skipValueComparisons" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXCore.ElementEquivalenceOptions.skipValueComparisons</p>
-</dd></dl>
+<dd></dd></dl>
 
 </section>
 <section id="methods">

diff --git a/generated/PyMaterialXCore.ElementEquivalenceResult.html b/generated/PyMaterialXCore.ElementEquivalenceResult.html
@@ -88,26 +88,22 @@ <h2>Properties<a class="headerlink" href="#properties" title="Link to this headi
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXCore.ElementEquivalenceResult.attributeName">
 <span class="sig-name descname"><span class="pre">attributeName</span></span><a class="headerlink" href="#PyMaterialXCore.ElementEquivalenceResult.attributeName" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXCore.ElementEquivalenceResult.attributeName</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXCore.ElementEquivalenceResult.differenceType">
 <span class="sig-name descname"><span class="pre">differenceType</span></span><a class="headerlink" href="#PyMaterialXCore.ElementEquivalenceResult.differenceType" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXCore.ElementEquivalenceResult.differenceType</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXCore.ElementEquivalenceResult.path1">
 <span class="sig-name descname"><span class="pre">path1</span></span><a class="headerlink" href="#PyMaterialXCore.ElementEquivalenceResult.path1" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXCore.ElementEquivalenceResult.path1</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXCore.ElementEquivalenceResult.path2">
 <span class="sig-name descname"><span class="pre">path2</span></span><a class="headerlink" href="#PyMaterialXCore.ElementEquivalenceResult.path2" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXCore.ElementEquivalenceResult.path2</p>
-</dd></dl>
+<dd></dd></dl>
 
 </section>
 <section id="methods">

diff --git a/generated/PyMaterialXCore.Matrix33.html b/generated/PyMaterialXCore.Matrix33.html
@@ -105,8 +105,7 @@ <h2>Properties<a class="headerlink" href="#properties" title="Link to this headi
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXCore.Matrix33.IDENTITY">
 <span class="sig-name descname"><span class="pre">IDENTITY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;PyMaterialXCore.Matrix33</span> <span class="pre">object&gt;</span></em><a class="headerlink" href="#PyMaterialXCore.Matrix33.IDENTITY" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXCore.Matrix33.IDENTITY</p>
-</dd></dl>
+<dd></dd></dl>
 
 </section>
 <section id="methods">

diff --git a/generated/PyMaterialXCore.Matrix44.html b/generated/PyMaterialXCore.Matrix44.html
@@ -111,8 +111,7 @@ <h2>Properties<a class="headerlink" href="#properties" title="Link to this headi
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXCore.Matrix44.IDENTITY">
 <span class="sig-name descname"><span class="pre">IDENTITY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;PyMaterialXCore.Matrix44</span> <span class="pre">object&gt;</span></em><a class="headerlink" href="#PyMaterialXCore.Matrix44.IDENTITY" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXCore.Matrix44.IDENTITY</p>
-</dd></dl>
+<dd></dd></dl>
 
 </section>
 <section id="methods">

diff --git a/generated/PyMaterialXFormat.ExceptionFileMissing.html b/generated/PyMaterialXFormat.ExceptionFileMissing.html
@@ -39,6 +39,12 @@ <h1>PyMaterialXFormat.ExceptionFileMissing<a class="headerlink" href="#pymateria
 <dt class="sig sig-object py" id="PyMaterialXFormat.ExceptionFileMissing">
 <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ExceptionFileMissing</span></span><a class="headerlink" href="#PyMaterialXFormat.ExceptionFileMissing" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
+<p>A type of exception that is raised when a requested file cannot be opened.</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_file_missing.html">https://materialx.org/docs/api/class_exception_file_missing.html</a></p>
+</dd>
+</dl>
 </dd></dl>
 
 </section>

diff --git a/generated/PyMaterialXFormat.ExceptionParseError.html b/generated/PyMaterialXFormat.ExceptionParseError.html
@@ -39,6 +39,13 @@ <h1>PyMaterialXFormat.ExceptionParseError<a class="headerlink" href="#pymaterial
 <dt class="sig sig-object py" id="PyMaterialXFormat.ExceptionParseError">
 <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ExceptionParseError</span></span><a class="headerlink" href="#PyMaterialXFormat.ExceptionParseError" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
+<p>A type of exception that is raised when a requested document cannot be
+parsed.</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_parse_error.html">https://materialx.org/docs/api/class_exception_parse_error.html</a></p>
+</dd>
+</dl>
 </dd></dl>
 
 </section>

diff --git a/generated/PyMaterialXFormat.FilePath.html b/generated/PyMaterialXFormat.FilePath.html
@@ -39,6 +39,12 @@ <h1>PyMaterialXFormat.FilePath<a class="headerlink" href="#pymaterialxformat-fil
 <dt class="sig sig-object py" id="PyMaterialXFormat.FilePath">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FilePath</span></span><a class="headerlink" href="#PyMaterialXFormat.FilePath" 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 generic file path, supporting both syntactic and file system operations.</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_file_path.html">https://materialx.org/docs/api/class_file_path.html</a></p>
+</dd>
+</dl>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

diff --git a/generated/PyMaterialXFormat.FileSearchPath.html b/generated/PyMaterialXFormat.FileSearchPath.html
@@ -39,6 +39,13 @@ <h1>PyMaterialXFormat.FileSearchPath<a class="headerlink" href="#pymaterialxform
 <dt class="sig sig-object py" id="PyMaterialXFormat.FileSearchPath">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FileSearchPath</span></span><a class="headerlink" href="#PyMaterialXFormat.FileSearchPath" 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 sequence of file paths, which may be queried to find the first instance
+of a given filename on the file system.</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_file_search_path.html">https://materialx.org/docs/api/class_file_search_path.html</a></p>
+</dd>
+</dl>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

diff --git a/generated/PyMaterialXFormat.Format.html b/generated/PyMaterialXFormat.Format.html
@@ -39,10 +39,20 @@ <h1>PyMaterialXFormat.Format<a class="headerlink" href="#pymaterialxformat-forma
 <dt class="sig sig-object py" id="PyMaterialXFormat.Format">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Format</span></span><a class="headerlink" href="#PyMaterialXFormat.Format" 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>
+<blockquote>
+<div><p>Enumeration of <a class="reference internal" href="PyMaterialXFormat.FilePath.html#PyMaterialXFormat.FilePath" title="PyMaterialXFormat.FilePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FilePath</span></code></a> formats.</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_file_path.html#pub-types">https://materialx.org/docs/api/class_file_path.html#pub-types</a></p>
+</dd>
+</dl>
+</div></blockquote>
 <p>Members:</p>
-<p>FormatWindows</p>
-<p>FormatPosix</p>
-<p>FormatNative</p>
+<blockquote>
+<div><p>FormatWindows : Format indicating a Windows environment.</p>
+<p>FormatPosix : Format indicating a Linux or Mac environment.</p>
+<p>FormatNative : Format indicating the format used on the system for which the library was built.</p>
+</div></blockquote>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
@@ -56,32 +66,27 @@ <h2>Properties<a class="headerlink" href="#properties" title="Link to this headi
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXFormat.Format.FormatNative">
 <span class="sig-name descname"><span class="pre">FormatNative</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;Format.FormatPosix:</span> <span class="pre">1&gt;</span></em><a class="headerlink" href="#PyMaterialXFormat.Format.FormatNative" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXFormat.Format.FormatNative</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXFormat.Format.FormatPosix">
 <span class="sig-name descname"><span class="pre">FormatPosix</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;Format.FormatPosix:</span> <span class="pre">1&gt;</span></em><a class="headerlink" href="#PyMaterialXFormat.Format.FormatPosix" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXFormat.Format.FormatPosix</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXFormat.Format.FormatWindows">
 <span class="sig-name descname"><span class="pre">FormatWindows</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;Format.FormatWindows:</span> <span class="pre">0&gt;</span></em><a class="headerlink" href="#PyMaterialXFormat.Format.FormatWindows" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXFormat.Format.FormatWindows</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXFormat.Format.name">
 <span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#PyMaterialXFormat.Format.name" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXFormat.Format.name</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXFormat.Format.value">
 <span class="sig-name descname"><span class="pre">value</span></span><a class="headerlink" href="#PyMaterialXFormat.Format.value" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXFormat.Format.value</p>
-</dd></dl>
+<dd></dd></dl>
 
 </section>
 <section id="methods">

diff --git a/generated/PyMaterialXFormat.Type.html b/generated/PyMaterialXFormat.Type.html
@@ -39,10 +39,20 @@ <h1>PyMaterialXFormat.Type<a class="headerlink" href="#pymaterialxformat-type" t
 <dt class="sig sig-object py" id="PyMaterialXFormat.Type">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Type</span></span><a class="headerlink" href="#PyMaterialXFormat.Type" 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>
+<blockquote>
+<div><p>Enumeration of <a class="reference internal" href="PyMaterialXFormat.FilePath.html#PyMaterialXFormat.FilePath" title="PyMaterialXFormat.FilePath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FilePath</span></code></a> types.</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_file_path.html#pub-types">https://materialx.org/docs/api/class_file_path.html#pub-types</a></p>
+</dd>
+</dl>
+</div></blockquote>
 <p>Members:</p>
-<p>TypeRelative</p>
-<p>TypeAbsolute</p>
-<p>TypeNetwork</p>
+<blockquote>
+<div><p>TypeRelative : Type indicating a relative path, e.g. <code class="xref py py-obj docutils literal notranslate"><span class="pre">'a/b'</span></code>. This is the default file path type.</p>
+<p>TypeAbsolute : Type indicating an absolute path, e.g. <code class="xref py py-obj docutils literal notranslate"><span class="pre">'/a/b'</span></code>.</p>
+<p>TypeNetwork : Type indicating a network path on Windows, e.g. <code class="xref py py-obj docutils literal notranslate"><span class="pre">'\ab'</span></code>.</p>
+</div></blockquote>
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
@@ -56,32 +66,27 @@ <h2>Properties<a class="headerlink" href="#properties" title="Link to this headi
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXFormat.Type.TypeAbsolute">
 <span class="sig-name descname"><span class="pre">TypeAbsolute</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;Type.TypeAbsolute:</span> <span class="pre">1&gt;</span></em><a class="headerlink" href="#PyMaterialXFormat.Type.TypeAbsolute" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXFormat.Type.TypeAbsolute</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXFormat.Type.TypeNetwork">
 <span class="sig-name descname"><span class="pre">TypeNetwork</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;Type.TypeNetwork:</span> <span class="pre">2&gt;</span></em><a class="headerlink" href="#PyMaterialXFormat.Type.TypeNetwork" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXFormat.Type.TypeNetwork</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXFormat.Type.TypeRelative">
 <span class="sig-name descname"><span class="pre">TypeRelative</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;Type.TypeRelative:</span> <span class="pre">0&gt;</span></em><a class="headerlink" href="#PyMaterialXFormat.Type.TypeRelative" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXFormat.Type.TypeRelative</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXFormat.Type.name">
 <span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#PyMaterialXFormat.Type.name" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXFormat.Type.name</p>
-</dd></dl>
+<dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="PyMaterialXFormat.Type.value">
 <span class="sig-name descname"><span class="pre">value</span></span><a class="headerlink" href="#PyMaterialXFormat.Type.value" title="Link to this definition">¶</a></dt>
-<dd><p>No docstring available for PyMaterialXFormat.Type.value</p>
-</dd></dl>
+<dd></dd></dl>
 
 </section>
 <section id="methods">