Skip to content

Commit

Permalink
update html docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jblance authored Oct 28, 2024
1 parent 57cdb81 commit 39a8558
Show file tree
Hide file tree
Showing 25 changed files with 729 additions and 7 deletions.
7 changes: 7 additions & 0 deletions docs/html/_sources/powermon.libs.config.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
powermon.libs.config module
===========================

.. automodule:: powermon.libs.config
:members:
:no-undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/html/_sources/powermon.libs.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Submodules
:maxdepth: 4

powermon.libs.apicoordinator
powermon.libs.config
powermon.libs.daemon
powermon.libs.errors
powermon.libs.mqttbroker
Expand Down
7 changes: 7 additions & 0 deletions docs/html/_sources/powermon.protocols.heltec.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
powermon.protocols.heltec module
================================

.. automodule:: powermon.protocols.heltec
:members:
:no-undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/html/_sources/powermon.protocols.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Submodules
powermon.protocols.abstractprotocol
powermon.protocols.daly
powermon.protocols.helpers
powermon.protocols.heltec
powermon.protocols.jkserial
powermon.protocols.neey
powermon.protocols.pi18
Expand Down
1 change: 1 addition & 0 deletions docs/html/_sources/powermon.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ Submodules

powermon.cli
powermon.device
powermon.runner
7 changes: 7 additions & 0 deletions docs/html/_sources/powermon.runner.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
powermon.runner module
======================

.. automodule:: powermon.runner
:members:
:no-undoc-members:
:show-inheritance:
41 changes: 38 additions & 3 deletions docs/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -485,10 +485,12 @@ <h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="powermon.outputformats.hass.html#powermon.outputformats.hass.Hass">Hass (class in powermon.outputformats.hass)</a>
</li>
<li><a href="powermon.configmodel.format_config_model.html#powermon.configmodel.format_config_model.HassFormatConfig">HassFormatConfig (class in powermon.configmodel.format_config_model)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="powermon.configmodel.format_config_model.html#powermon.configmodel.format_config_model.HassFormatConfig">HassFormatConfig (class in powermon.configmodel.format_config_model)</a>
<li><a href="powermon.protocols.heltec.html#powermon.protocols.heltec.Heltec">Heltec (class in powermon.protocols.heltec)</a>
</li>
<li><a href="powermon.outputformats.htmltable.html#powermon.outputformats.htmltable.HtmlTable">HtmlTable (class in powermon.outputformats.htmltable)</a>
</li>
Expand Down Expand Up @@ -579,7 +581,11 @@ <h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="powermon.cli.html#powermon.cli.main">main() (in module powermon.cli)</a>

<ul>
<li><a href="powermon.runner.html#powermon.runner.main">(in module powermon.runner)</a>
</li>
</ul></li>
<li><a href="powermon.configmodel.config_model.html#powermon.configmodel.config_model.APIConfig.model_computed_fields">model_computed_fields (powermon.configmodel.config_model.APIConfig attribute)</a>

<ul>
Expand Down Expand Up @@ -803,6 +809,8 @@ <h2 id="M">M</h2>
<li><a href="powermon.libs.html#module-powermon.libs">powermon.libs</a>
</li>
<li><a href="powermon.libs.apicoordinator.html#module-powermon.libs.apicoordinator">powermon.libs.apicoordinator</a>
</li>
<li><a href="powermon.libs.config.html#module-powermon.libs.config">powermon.libs.config</a>
</li>
<li><a href="powermon.libs.daemon.html#module-powermon.libs.daemon">powermon.libs.daemon</a>
</li>
Expand Down Expand Up @@ -861,6 +869,8 @@ <h2 id="M">M</h2>
<li><a href="powermon.protocols.daly.html#module-powermon.protocols.daly">powermon.protocols.daly</a>
</li>
<li><a href="powermon.protocols.helpers.html#module-powermon.protocols.helpers">powermon.protocols.helpers</a>
</li>
<li><a href="powermon.protocols.heltec.html#module-powermon.protocols.heltec">powermon.protocols.heltec</a>
</li>
<li><a href="powermon.protocols.jkserial.html#module-powermon.protocols.jkserial">powermon.protocols.jkserial</a>
</li>
Expand All @@ -873,6 +883,8 @@ <h2 id="M">M</h2>
<li><a href="powermon.protocols.pi30max.html#module-powermon.protocols.pi30max">powermon.protocols.pi30max</a>
</li>
<li><a href="powermon.protocols.ved.html#module-powermon.protocols.ved">powermon.protocols.ved</a>
</li>
<li><a href="powermon.runner.html#module-powermon.runner">powermon.runner</a>
</li>
</ul></li>
<li><a href="powermon.outputs.mqtt.html#powermon.outputs.mqtt.MQTT">MQTT (class in powermon.outputs.mqtt)</a>
Expand Down Expand Up @@ -1007,6 +1019,13 @@ <h2 id="P">P</h2>

<ul>
<li><a href="powermon.libs.apicoordinator.html#module-powermon.libs.apicoordinator">module</a>
</li>
</ul></li>
<li>
powermon.libs.config

<ul>
<li><a href="powermon.libs.config.html#module-powermon.libs.config">module</a>
</li>
</ul></li>
<li>
Expand Down Expand Up @@ -1100,15 +1119,15 @@ <h2 id="P">P</h2>
<li><a href="powermon.outputformats.table.html#module-powermon.outputformats.table">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
powermon.outputformats.topics

<ul>
<li><a href="powermon.outputformats.topics.html#module-powermon.outputformats.topics">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
powermon.outputs

Expand Down Expand Up @@ -1212,6 +1231,13 @@ <h2 id="P">P</h2>

<ul>
<li><a href="powermon.protocols.helpers.html#module-powermon.protocols.helpers">module</a>
</li>
</ul></li>
<li>
powermon.protocols.heltec

<ul>
<li><a href="powermon.protocols.heltec.html#module-powermon.protocols.heltec">module</a>
</li>
</ul></li>
<li>
Expand Down Expand Up @@ -1254,6 +1280,13 @@ <h2 id="P">P</h2>

<ul>
<li><a href="powermon.protocols.ved.html#module-powermon.protocols.ved">module</a>
</li>
</ul></li>
<li>
powermon.runner

<ul>
<li><a href="powermon.runner.html#module-powermon.runner">module</a>
</li>
</ul></li>
<li><a href="powermon.libs.errors.html#powermon.libs.errors.PowermonProtocolError">PowermonProtocolError</a>
Expand Down Expand Up @@ -1306,6 +1339,8 @@ <h2 id="R">R</h2>
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="powermon.libs.config.html#powermon.libs.config.safe_config">safe_config() (in module powermon.libs.config)</a>
</li>
<li><a href="powermon.outputs.screen.html#powermon.outputs.screen.Screen">Screen (class in powermon.outputs.screen)</a>
</li>
<li><a href="powermon.ports.abstractport.html#powermon.ports.abstractport.AbstractPort.send_and_receive">send_and_receive() (powermon.ports.abstractport.AbstractPort method)</a>
Expand Down
1 change: 1 addition & 0 deletions docs/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Link to this
<li class="toctree-l3"><a class="reference internal" href="powermon.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="powermon.cli.html">powermon.cli module</a></li>
<li class="toctree-l4"><a class="reference internal" href="powermon.device.html">powermon.device module</a></li>
<li class="toctree-l4"><a class="reference internal" href="powermon.runner.html">powermon.runner module</a></li>
</ul>
</li>
</ul>
Expand Down
5 changes: 5 additions & 0 deletions docs/html/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@ <h1>powermon<a class="headerlink" href="#powermon" title="Link to this heading">
<li class="toctree-l3"><a class="reference internal" href="powermon.protocols.html">powermon.protocols package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="powermon.protocols.html#powermon.protocols.Protocol"><code class="docutils literal notranslate"><span class="pre">Protocol</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="powermon.protocols.html#powermon.protocols.get_protocol_definition"><code class="docutils literal notranslate"><span class="pre">get_protocol_definition()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="powermon.protocols.html#powermon.protocols.list_commands"><code class="docutils literal notranslate"><span class="pre">list_commands()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="powermon.protocols.html#powermon.protocols.list_protocols"><code class="docutils literal notranslate"><span class="pre">list_protocols()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="powermon.protocols.html#submodules">Submodules</a></li>
</ul>
Expand All @@ -221,6 +222,10 @@ <h1>powermon<a class="headerlink" href="#powermon" title="Link to this heading">
<li class="toctree-l4"><a class="reference internal" href="powermon.device.html#powermon.device.DeviceInfoDTO"><code class="docutils literal notranslate"><span class="pre">DeviceInfoDTO</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="powermon.runner.html">powermon.runner module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="powermon.runner.html#powermon.runner.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
Expand Down
Binary file modified docs/html/objects.inv
Binary file not shown.
12 changes: 12 additions & 0 deletions docs/html/powermon.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,10 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l4"><a class="reference internal" href="powermon.libs.apicoordinator.html#powermon.libs.apicoordinator.ApiCoordinatorDTO"><code class="docutils literal notranslate"><span class="pre">ApiCoordinatorDTO</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="powermon.libs.config.html">powermon.libs.config module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="powermon.libs.config.html#powermon.libs.config.safe_config"><code class="docutils literal notranslate"><span class="pre">safe_config()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="powermon.libs.daemon.html">powermon.libs.daemon module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="powermon.libs.daemon.html#powermon.libs.daemon.Daemon"><code class="docutils literal notranslate"><span class="pre">Daemon</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="powermon.libs.daemon.html#powermon.libs.daemon.DaemonDTO"><code class="docutils literal notranslate"><span class="pre">DaemonDTO</span></code></a></li>
Expand Down Expand Up @@ -378,6 +382,10 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l4"><a class="reference internal" href="powermon.protocols.helpers.html#powermon.protocols.helpers.victron_checksum"><code class="docutils literal notranslate"><span class="pre">victron_checksum()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="powermon.protocols.heltec.html">powermon.protocols.heltec module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="powermon.protocols.heltec.html#powermon.protocols.heltec.Heltec"><code class="docutils literal notranslate"><span class="pre">Heltec</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="powermon.protocols.jkserial.html">powermon.protocols.jkserial module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="powermon.protocols.jkserial.html#powermon.protocols.jkserial.JkSerial"><code class="docutils literal notranslate"><span class="pre">JkSerial</span></code></a></li>
</ul>
Expand Down Expand Up @@ -449,6 +457,10 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="powermon.runner.html">powermon.runner module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="powermon.runner.html#powermon.runner.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
</ul>
</li>
</ul>
</div>
</section>
Expand Down
Loading

0 comments on commit 39a8558

Please sign in to comment.