docs: updated repo documentation

urbanopt · Oct 22, 2023 · cf06faa · cf06faa
1 parent 13a4d2c
commit cf06faa
Show file tree

Hide file tree

Showing 135 changed files with 4,152 additions and 3,499 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: 5d3c4a4ccda3ee47f91ed6f40b4748eb
+config: b8fa7a01b07049f6ebf5df1a5cc0fa3a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_autosummary/geojson_modelica_translator.geojson.html b/_autosummary/geojson_modelica_translator.geojson.html
@@ -1,21 +1,18 @@
-
 <!DOCTYPE html>
 
-<html lang="en">
+<html lang="en" data-content_root="../">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>geojson &#8212; GeoJSON Modelica Translator v0.5.0 documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
-    <link rel="stylesheet" type="text/css" href="../_static/custom_sphinx_styles.css" />
+    <title>geojson &#8212; GeoJSON Modelica Translator v0.6.0-rc2 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=4cc3df7e" />
+    <link rel="stylesheet" type="text/css" href="../_static/custom_sphinx_styles.css?v=c57217d6" />
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-    <script src="../_static/jquery.js"></script>
-    <script src="../_static/underscore.js"></script>
-    <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
-    <script src="../_static/doctools.js"></script>
+    <script src="../_static/documentation_options.js?v=5a89af5d"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -37,7 +34,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="geojson_modelica_translator.html" title="geojson_modelica_translator"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">GeoJSON Modelica Translator v0.5.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">GeoJSON Modelica Translator v0.6.0-rc2 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../developer_resources.html" >Developer Resources</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="geojson_modelica_translator.html" accesskey="U">geojson_modelica_translator</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">geojson</a></li> 
@@ -50,13 +47,9 @@ <h3>Navigation</h3>
           <div class="body" role="main">
 
   <section id="module-geojson_modelica_translator.geojson">
-<span id="geojson"></span><h1>geojson<a class="headerlink" href="#module-geojson_modelica_translator.geojson" title="Permalink to this heading">¶</a></h1>
+<span id="geojson"></span><h1>geojson<a class="headerlink" href="#module-geojson_modelica_translator.geojson" title="Link to this heading">¶</a></h1>
 <p class="rubric">Modules</p>
 <table class="autosummary longtable docutils align-default">
-<colgroup>
-<col style="width: 10%" />
-<col style="width: 90%" />
-</colgroup>
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="geojson_modelica_translator.geojson.schemas.html#module-geojson_modelica_translator.geojson.schemas" title="geojson_modelica_translator.geojson.schemas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">geojson_modelica_translator.geojson.schemas</span></code></a></p></td>
 <td><p></p></td>
@@ -121,15 +114,15 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="geojson_modelica_translator.html" title="geojson_modelica_translator"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">GeoJSON Modelica Translator v0.5.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">GeoJSON Modelica Translator v0.6.0-rc2 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../developer_resources.html" >Developer Resources</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="geojson_modelica_translator.html" >geojson_modelica_translator</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">geojson</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2019,2023 - Alliance for Sustainable Energy, LLC.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
+    &#169; Copyright 2019,2023 - Alliance for Sustainable Energy, LLC.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
     </div>
   </body>
 </html>
diff --git a/_autosummary/geojson_modelica_translator.geojson.schemas.Schemas.html b/_autosummary/geojson_modelica_translator.geojson.schemas.Schemas.html
@@ -1,21 +1,18 @@
-
 <!DOCTYPE html>
 
-<html lang="en">
+<html lang="en" data-content_root="../">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>Schemas &#8212; GeoJSON Modelica Translator v0.5.0 documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
-    <link rel="stylesheet" type="text/css" href="../_static/custom_sphinx_styles.css" />
+    <title>Schemas &#8212; GeoJSON Modelica Translator v0.6.0-rc2 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=4cc3df7e" />
+    <link rel="stylesheet" type="text/css" href="../_static/custom_sphinx_styles.css?v=c57217d6" />
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-    <script src="../_static/jquery.js"></script>
-    <script src="../_static/underscore.js"></script>
-    <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
-    <script src="../_static/doctools.js"></script>
+    <script src="../_static/documentation_options.js?v=5a89af5d"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -37,7 +34,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="geojson_modelica_translator.geojson.schemas.html" title="schemas"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">GeoJSON Modelica Translator v0.5.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">GeoJSON Modelica Translator v0.6.0-rc2 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../developer_resources.html" >Developer Resources</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="geojson_modelica_translator.html" >geojson_modelica_translator</a> &#187;</li>
           <li class="nav-item nav-item-3"><a href="geojson_modelica_translator.geojson.html" >geojson</a> &#187;</li>
@@ -52,24 +49,20 @@ <h3>Navigation</h3>
           <div class="body" role="main">
 
   <section id="schemas">
-<h1>Schemas<a class="headerlink" href="#schemas" title="Permalink to this heading">¶</a></h1>
+<h1>Schemas<a class="headerlink" href="#schemas" title="Link to this heading">¶</a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="geojson_modelica_translator.geojson.schemas.Schemas">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">geojson_modelica_translator.geojson.schemas.</span></span><span class="sig-name descname"><span class="pre">Schemas</span></span><a class="headerlink" href="#geojson_modelica_translator.geojson.schemas.Schemas" title="Permalink to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">geojson_modelica_translator.geojson.schemas.</span></span><span class="sig-name descname"><span class="pre">Schemas</span></span><a class="headerlink" href="#geojson_modelica_translator.geojson.schemas.Schemas" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <p>Class to hold the various schemas</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="geojson_modelica_translator.geojson.schemas.Schemas.__init__">
-<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#geojson_modelica_translator.geojson.schemas.Schemas.__init__" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#geojson_modelica_translator.geojson.schemas.Schemas.__init__" title="Link to this definition">¶</a></dt>
 <dd><p>Load in the schemas</p>
 </dd></dl>
 
 <p class="rubric">Methods</p>
 <table class="autosummary longtable docutils align-default">
-<colgroup>
-<col style="width: 10%" />
-<col style="width: 90%" />
-</colgroup>
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="#geojson_modelica_translator.geojson.schemas.Schemas.__init__" title="geojson_modelica_translator.geojson.schemas.Schemas.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>()</p></td>
 <td><p>Load in the schemas</p></td>
@@ -84,22 +77,22 @@ <h1>Schemas<a class="headerlink" href="#schemas" title="Permalink to this headin
 </table>
 <dl class="py method">
 <dt class="sig sig-object py" id="geojson_modelica_translator.geojson.schemas.Schemas.retrieve">
-<span class="sig-name descname"><span class="pre">retrieve</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#geojson_modelica_translator.geojson.schemas.Schemas.retrieve" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">retrieve</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#geojson_modelica_translator.geojson.schemas.Schemas.retrieve" title="Link to this definition">¶</a></dt>
 <dd><p>name of the schema to retrieve</p>
 </dd></dl>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="geojson_modelica_translator.geojson.schemas.Schemas.validate">
-<span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#geojson_modelica_translator.geojson.schemas.Schemas.validate" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#geojson_modelica_translator.geojson.schemas.Schemas.validate" title="Link to this definition">¶</a></dt>
 <dd><p>Validate an instance against a loaded schema</p>
 <dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>name</strong> – str, name of the schema to validate against</p></li>
 <li><p><strong>instance</strong> – dict, instance to validate</p></li>
 </ul>
 </dd>
-<dt class="field-even">Returns</dt>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p></p>
 </dd>
 </dl>
@@ -116,6 +109,21 @@ <h1>Schemas<a class="headerlink" href="#schemas" title="Permalink to this headin
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">Schemas</a><ul>
+<li><a class="reference internal" href="#geojson_modelica_translator.geojson.schemas.Schemas"><code class="docutils literal notranslate"><span class="pre">Schemas</span></code></a><ul>
+<li><a class="reference internal" href="#geojson_modelica_translator.geojson.schemas.Schemas.__init__"><code class="docutils literal notranslate"><span class="pre">Schemas.__init__()</span></code></a></li>
+<li><a class="reference internal" href="#geojson_modelica_translator.geojson.schemas.Schemas.retrieve"><code class="docutils literal notranslate"><span class="pre">Schemas.retrieve()</span></code></a></li>
+<li><a class="reference internal" href="#geojson_modelica_translator.geojson.schemas.Schemas.validate"><code class="docutils literal notranslate"><span class="pre">Schemas.validate()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+  </div>
   <div>
     <h4>Previous topic</h4>
     <p class="topless"><a href="geojson_modelica_translator.geojson.schemas.html"
@@ -162,7 +170,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="geojson_modelica_translator.geojson.schemas.html" title="schemas"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">GeoJSON Modelica Translator v0.5.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">GeoJSON Modelica Translator v0.6.0-rc2 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../developer_resources.html" >Developer Resources</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="geojson_modelica_translator.html" >geojson_modelica_translator</a> &#187;</li>
           <li class="nav-item nav-item-3"><a href="geojson_modelica_translator.geojson.html" >geojson</a> &#187;</li>
@@ -171,8 +179,8 @@ <h3>Navigation</h3>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2019,2023 - Alliance for Sustainable Energy, LLC.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
+    &#169; Copyright 2019,2023 - Alliance for Sustainable Energy, LLC.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
     </div>
   </body>
 </html>