Skip to content

Commit

Permalink
HTML docs update by Jenkins
Browse files Browse the repository at this point in the history
  • Loading branch information
Jenkins Automation Server committed Jul 22, 2024
1 parent b649ee0 commit 326bbb9
Show file tree
Hide file tree
Showing 23 changed files with 4,777 additions and 19 deletions.
4 changes: 4 additions & 0 deletions _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,11 @@ <h1>All modules for which code is available</h1>
<ul><li><a href="opera/pge/base/base_pge.html">opera.pge.base.base_pge</a></li>
<li><a href="opera/pge/base/runconfig.html">opera.pge.base.runconfig</a></li>
<li><a href="opera/pge/cslc_s1/cslc_s1_pge.html">opera.pge.cslc_s1.cslc_s1_pge</a></li>
<li><a href="opera/pge/disp_s1/disp_s1_pge.html">opera.pge.disp_s1.disp_s1_pge</a></li>
<li><a href="opera/pge/dswx_hls/dswx_hls_pge.html">opera.pge.dswx_hls.dswx_hls_pge</a></li>
<li><a href="opera/pge/dswx_ni/dswx_ni_pge.html">opera.pge.dswx_ni.dswx_ni_pge</a></li>
<li><a href="opera/pge/dswx_s1/dswx_s1_pge.html">opera.pge.dswx_s1.dswx_s1_pge</a></li>
<li><a href="opera/pge/rtc_s1/rtc_s1_pge.html">opera.pge.rtc_s1.rtc_s1_pge</a></li>
<li><a href="opera/util/error_codes.html">opera.util.error_codes</a></li>
<li><a href="opera/util/logger.html">opera.util.logger</a></li>
<li><a href="opera/util/run_utils.html">opera.util.run_utils</a></li>
Expand Down
951 changes: 951 additions & 0 deletions _modules/opera/pge/disp_s1/disp_s1_pge.html

Large diffs are not rendered by default.

465 changes: 465 additions & 0 deletions _modules/opera/pge/dswx_ni/dswx_ni_pge.html

Large diffs are not rendered by default.

918 changes: 918 additions & 0 deletions _modules/opera/pge/dswx_s1/dswx_s1_pge.html

Large diffs are not rendered by default.

1,086 changes: 1,086 additions & 0 deletions _modules/opera/pge/rtc_s1/rtc_s1_pge.html

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions _sources/opera.pge.disp_s1.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
opera.pge.disp_s1 package
=========================

Submodules
----------

opera.pge.disp\_s1.disp\_s1\_pge module
---------------------------------------

.. automodule:: opera.pge.disp_s1.disp_s1_pge
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: opera.pge.disp_s1
:members:
:undoc-members:
:show-inheritance:
21 changes: 21 additions & 0 deletions _sources/opera.pge.dswx_ni.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
opera.pge.dswx_ni package
=========================

Submodules
----------

opera.pge.dswx\_ni.dswx\_ni\_pge module
---------------------------------------

.. automodule:: opera.pge.dswx_ni.dswx_ni_pge
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: opera.pge.dswx_ni
:members:
:undoc-members:
:show-inheritance:
21 changes: 21 additions & 0 deletions _sources/opera.pge.dswx_s1.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
opera.pge.dswx_s1 package
=========================

Submodules
----------

opera.pge.dswx\_s1.dswx\_s1\_pge module
---------------------------------------

.. automodule:: opera.pge.dswx_s1.dswx_s1_pge
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: opera.pge.dswx_s1
:members:
:undoc-members:
:show-inheritance:
4 changes: 4 additions & 0 deletions _sources/opera.pge.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Submodules
opera.pge.base
opera.pge.dswx_hls
opera.pge.cslc_s1
opera.pge.rtc_s1
opera.pge.dswx_s1
opera.pge.disp_s1
opera.pge.dswx_ni

Module contents
---------------
Expand Down
21 changes: 21 additions & 0 deletions _sources/opera.pge.rtc_s1.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
opera.pge.rtc_s1 package
=========================

Submodules
----------

opera.pge.rtc\_s1.rtc\_s1\_pge module
-------------------------------------

.. automodule:: opera.pge.rtc_s1.rtc_s1_pge
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: opera.pge.rtc_s1
:members:
:undoc-members:
:show-inheritance:
170 changes: 158 additions & 12 deletions genindex.html

Large diffs are not rendered by default.

Binary file modified objects.inv
Binary file not shown.
24 changes: 24 additions & 0 deletions opera.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,30 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
<li class="toctree-l4"><a class="reference internal" href="opera.pge.cslc_s1.html#module-opera.pge.cslc_s1">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="opera.pge.rtc_s1.html">opera.pge.rtc_s1 package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.rtc_s1.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.rtc_s1.html#module-opera.pge.rtc_s1.rtc_s1_pge">opera.pge.rtc_s1.rtc_s1_pge module</a></li>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.rtc_s1.html#module-opera.pge.rtc_s1">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="opera.pge.dswx_s1.html">opera.pge.dswx_s1 package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.dswx_s1.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.dswx_s1.html#module-opera.pge.dswx_s1.dswx_s1_pge">opera.pge.dswx_s1.dswx_s1_pge module</a></li>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.dswx_s1.html#module-opera.pge.dswx_s1">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="opera.pge.disp_s1.html">opera.pge.disp_s1 package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.disp_s1.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.disp_s1.html#module-opera.pge.disp_s1.disp_s1_pge">opera.pge.disp_s1.disp_s1_pge module</a></li>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.disp_s1.html#module-opera.pge.disp_s1">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="opera.pge.dswx_ni.html">opera.pge.dswx_ni package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.dswx_ni.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.dswx_ni.html#module-opera.pge.dswx_ni.dswx_ni_pge">opera.pge.dswx_ni.dswx_ni_pge module</a></li>
<li class="toctree-l4"><a class="reference internal" href="opera.pge.dswx_ni.html#module-opera.pge.dswx_ni">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="opera.pge.html#module-opera.pge">Module contents</a><ul>
Expand Down
4 changes: 2 additions & 2 deletions opera.pge.base.html
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ <h3>runconfig.py<a class="headerlink" href="#runconfig-py" title="Permalink to t
</section>
<dl class="py data">
<dt class="sig sig-object py" id="opera.pge.base.runconfig.BASE_PGE_SCHEMA">
<span class="sig-prename descclassname"><span class="pre">opera.pge.base.runconfig.</span></span><span class="sig-name descname"><span class="pre">BASE_PGE_SCHEMA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/var/lib/jenkins/workspace/se-pipeline_release_4.0.0-er.2.0/src/opera/pge/base/schema/base_pge_schema.yaml'</span></em><a class="headerlink" href="#opera.pge.base.runconfig.BASE_PGE_SCHEMA" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">opera.pge.base.runconfig.</span></span><span class="sig-name descname"><span class="pre">BASE_PGE_SCHEMA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/var/lib/jenkins/workspace/opera-pge-sandbox-pipeline/src/opera/pge/base/schema/base_pge_schema.yaml'</span></em><a class="headerlink" href="#opera.pge.base.runconfig.BASE_PGE_SCHEMA" title="Permalink to this definition"></a></dt>
<dd><p>Path to the Yamale schema applicable to the PGE portion of each RunConfig</p>
</dd></dl>

Expand Down Expand Up @@ -521,7 +521,7 @@ <h3>runconfig.py<a class="headerlink" href="#runconfig-py" title="Permalink to t

<dl class="py method">
<dt class="sig sig-object py" id="opera.pge.base.runconfig.RunConfig.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">pge_schema_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/var/lib/jenkins/workspace/se-pipeline_release_4.0.0-er.2.0/src/opera/pge/base/schema/base_pge_schema.yaml'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/opera/pge/base/runconfig.html#RunConfig.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#opera.pge.base.runconfig.RunConfig.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">pge_schema_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/var/lib/jenkins/workspace/opera-pge-sandbox-pipeline/src/opera/pge/base/schema/base_pge_schema.yaml'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict_mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/opera/pge/base/runconfig.html#RunConfig.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#opera.pge.base.runconfig.RunConfig.validate" title="Permalink to this definition"></a></dt>
<dd><p>Validates the RunConfig using a combination of the base PGE schema,
and the specific SAS schema defined by the RunConfig itself.</p>
<dl class="field-list simple">
Expand Down
4 changes: 2 additions & 2 deletions opera.pge.cslc_s1.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="opera.util package" href="opera.util.html" />
<link rel="next" title="opera.pge.rtc_s1 package" href="opera.pge.rtc_s1.html" />
<link rel="prev" title="opera.pge.dswx_hls package" href="opera.pge.dswx_hls.html" />
</head>

Expand Down Expand Up @@ -204,7 +204,7 @@ <h3>cslc_s1_pge.py<a class="headerlink" href="#cslc-s1-pge-py" title="Permalink
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="opera.pge.dswx_hls.html" class="btn btn-neutral float-left" title="opera.pge.dswx_hls package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="opera.util.html" class="btn btn-neutral float-right" title="opera.util package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="opera.pge.rtc_s1.html" class="btn btn-neutral float-right" title="opera.pge.rtc_s1 package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
Loading

0 comments on commit 326bbb9

Please sign in to comment.