docs: update build documentation

TRI-ML · Jul 27, 2023 · 12b92ff · 12b92ff
1 parent e2215a5
commit 12b92ff
Show file tree

Hide file tree

Showing 22 changed files with 116 additions and 60 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 1690d484bb4bd18c5c0ad91c42bf4c4c
+config: 2843565f09e74cd0916fd6bffb758a44
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v1.5-15-ga64e360',
+    VERSION: 'v1.5-16-g7106ca4',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/cli.html b/cli.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>DGP Command-Line Interface &#8212; DGP v1.5-15-ga64e360 documentation</title>
+    <title>DGP Command-Line Interface &#8212; DGP v1.5-16-g7106ca4 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="Welcome to DGP’s documentation!"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">DGP Command-Line Interface</a></li> 
       </ul>
     </div>
@@ -183,7 +183,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="Welcome to DGP’s documentation!"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">DGP Command-Line Interface</a></li> 
       </ul>
     </div>

diff --git a/contributing_guidelines.html b/contributing_guidelines.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Contribution Guidelines &#8212; DGP v1.5-15-ga64e360 documentation</title>
+    <title>Contribution Guidelines &#8212; DGP v1.5-16-g7106ca4 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="getting_started.html" title="Getting Started"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Contribution Guidelines</a></li> 
       </ul>
     </div>
@@ -298,7 +298,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="getting_started.html" title="Getting Started"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Contribution Guidelines</a></li> 
       </ul>
     </div>

diff --git a/dgp.annotations.html b/dgp.annotations.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>dgp.annotations package &#8212; DGP v1.5-15-ga64e360 documentation</title>
+    <title>dgp.annotations package &#8212; DGP v1.5-16-g7106ca4 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="dgp.html" title="dgp package"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="dgp.html" accesskey="U">dgp package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp.annotations package</a></li> 
       </ul>
@@ -1423,7 +1423,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="dgp.html" title="dgp package"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="dgp.html" >dgp package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp.annotations package</a></li> 
       </ul>

diff --git a/dgp.contribs.pd.html b/dgp.contribs.pd.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>dgp.contribs.pd package &#8212; DGP v1.5-15-ga64e360 documentation</title>
+    <title>dgp.contribs.pd package &#8212; DGP v1.5-16-g7106ca4 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
@@ -25,7 +25,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp.contribs.pd package</a></li> 
       </ul>
     </div>
@@ -267,7 +267,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp.contribs.pd package</a></li> 
       </ul>
     </div>

diff --git a/dgp.datasets.html b/dgp.datasets.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>dgp.datasets package &#8212; DGP v1.5-15-ga64e360 documentation</title>
+    <title>dgp.datasets package &#8212; DGP v1.5-16-g7106ca4 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="dgp.annotations.html" title="dgp.annotations package"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="dgp.html" accesskey="U">dgp package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp.datasets package</a></li> 
       </ul>
@@ -480,6 +480,8 @@ <h1>dgp.datasets package<a class="headerlink" href="#dgp-datasets-package" title
 <dl class="simple">
 <dt>TypeError</dt><dd><p>Raised if the datum type is unsupported.</p>
 </dd>
+<dt>Exception</dt><dd><p>Raised if datum’s filename is not supported</p>
+</dd>
 </dl>
 </dd></dl>
 
@@ -616,12 +618,12 @@ <h1>dgp.datasets package<a class="headerlink" href="#dgp-datasets-package" title
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="dgp.datasets.base_dataset.SceneContainer.cache_dir">
-<span class="sig-name descname"><span class="pre">cache_dir</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'/home/runner/.dgp/cache/dgp_diskcache_76199'</span></em><a class="headerlink" href="#dgp.datasets.base_dataset.SceneContainer.cache_dir" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">cache_dir</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'/home/runner/.dgp/cache/dgp_diskcache_45589'</span></em><a class="headerlink" href="#dgp.datasets.base_dataset.SceneContainer.cache_dir" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="dgp.datasets.base_dataset.SceneContainer.cache_suffix">
-<span class="sig-name descname"><span class="pre">cache_suffix</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'76199'</span></em><a class="headerlink" href="#dgp.datasets.base_dataset.SceneContainer.cache_suffix" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">cache_suffix</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'45589'</span></em><a class="headerlink" href="#dgp.datasets.base_dataset.SceneContainer.cache_suffix" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py property">
@@ -780,7 +782,7 @@ <h1>dgp.datasets package<a class="headerlink" href="#dgp-datasets-package" title
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="dgp.datasets.base_dataset.SceneContainer.random_str">
-<span class="sig-name descname"><span class="pre">random_str</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'76199'</span></em><a class="headerlink" href="#dgp.datasets.base_dataset.SceneContainer.random_str" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">random_str</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'45589'</span></em><a class="headerlink" href="#dgp.datasets.base_dataset.SceneContainer.random_str" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py property">
@@ -1052,7 +1054,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="dgp.annotations.html" title="dgp.annotations package"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="dgp.html" >dgp package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp.datasets package</a></li> 
       </ul>

diff --git a/dgp.html b/dgp.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>dgp package &#8212; DGP v1.5-15-ga64e360 documentation</title>
+    <title>dgp package &#8212; DGP v1.5-16-g7106ca4 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="dgp_schema.html" title="TRI Dataset Governance Policy (DGP) Schema"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp package</a></li> 
       </ul>
     </div>
@@ -201,7 +201,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="dgp_schema.html" title="TRI Dataset Governance Policy (DGP) Schema"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp package</a></li> 
       </ul>
     </div>

diff --git a/dgp.scripts.html b/dgp.scripts.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>dgp.scripts package &#8212; DGP v1.5-15-ga64e360 documentation</title>
+    <title>dgp.scripts package &#8212; DGP v1.5-16-g7106ca4 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="dgp.datasets.html" title="dgp.datasets package"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="dgp.html" accesskey="U">dgp package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp.scripts package</a></li> 
       </ul>
@@ -116,7 +116,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="dgp.datasets.html" title="dgp.datasets package"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="dgp.html" >dgp package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp.scripts package</a></li> 
       </ul>

diff --git a/dgp.utils.cloud.html b/dgp.utils.cloud.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>dgp.utils.cloud package &#8212; DGP v1.5-15-ga64e360 documentation</title>
+    <title>dgp.utils.cloud package &#8212; DGP v1.5-16-g7106ca4 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
     <link rel="stylesheet" type="text/css" href="_static/tri_colors.css" />
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="dgp.utils.html" title="dgp.utils package"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="dgp.html" >dgp package</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="dgp.utils.html" accesskey="U">dgp.utils package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp.utils.cloud package</a></li> 
@@ -495,7 +495,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="dgp.utils.html" title="dgp.utils package"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-15-ga64e360 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">DGP v1.5-16-g7106ca4 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="dgp.html" >dgp package</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="dgp.utils.html" >dgp.utils package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dgp.utils.cloud package</a></li>