Skip to content

Commit

Permalink
Add doc build snapshot nightly
Browse files Browse the repository at this point in the history
  • Loading branch information
pionix-compiler committed Dec 8, 2023
1 parent 5c145d2 commit 800dcbe
Show file tree
Hide file tree
Showing 16 changed files with 40 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/latest/_generated/interfaces/evse_manager.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ <h2><span class="section-number">11.2.15.2. </span>Commands<a class="headerlink"
<div class="line">Enables the evse. EVSE is available for charging after this operation</div>
<div class="line"><strong>connector_id</strong>:<em>integer</em></div>
<div class="line-block">
<div class="line">Specifies the ID of the connector to disable. If 0, the whole EVSE should be enabled</div>
<div class="line">Specifies the ID of the connector to enable. If 0, the whole EVSE should be enabled</div>
</div>
<div class="line"><strong>Result</strong>:<em>boolean</em></div>
<div class="line-block">
Expand Down
5 changes: 5 additions & 0 deletions docs/latest/_generated/modules/EvseV2G.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ <h2><span class="section-number">11.1.14.1. </span>Module Configuration<a class=
<div class="line-block">
<div class="line">Output directory for the TLS key log file</div>
</div>
<div class="line"><strong>tls_timeout</strong>:<em>integer</em></div>
<div class="line"><em>default: 15000</em></div>
<div class="line-block">
<div class="line">Set the TLS timeout in ms when establishing a tls connection</div>
</div>
<div class="line"><strong>verify_contract_cert_chain</strong>:<em>boolean</em></div>
<div class="line"><em>default: False</em></div>
<div class="line-block">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Commands
| **enable**:*boolean*
| Enables the evse. EVSE is available for charging after this operation
| **connector_id**:*integer*
| Specifies the ID of the connector to disable. If 0, the whole EVSE should be enabled
| Specifies the ID of the connector to enable. If 0, the whole EVSE should be enabled
| **Result**:*boolean*
| Returns true if evse was enabled (or was enabled before), returns false if enable failed e.g. due to permanent fault.
| **disable**:*boolean*
Expand Down
3 changes: 3 additions & 0 deletions docs/latest/_sources/_generated/modules/EvseV2G.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ Module Configuration
| **tls_key_logging_path**:*string*
| *default: /tmp*
| Output directory for the TLS key log file
| **tls_timeout**:*integer*
| *default: 15000*
| Set the TLS timeout in ms when establishing a tls connection
| **verify_contract_cert_chain**:*boolean*
| *default: False*
| Specifies if the EVSE should verify the contract certificate chain locally.
Expand Down
6 changes: 3 additions & 3 deletions docs/latest/_sources/general/02_detail_pre_setup.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Use `apt` to get your needed libraries installed:
.. code-block:: bash
sudo apt update
sudo apt install -y python3-pip git rsync wget cmake doxygen graphviz build-essential clang-tidy cppcheck openjdk-17-jdk npm docker docker-compose libboost-all-dev nodejs libssl-dev libsqlite3-dev clang-format curl rfkill libpcap-dev libevent-dev pkg-config
sudo apt install -y python3-pip git rsync wget cmake doxygen graphviz build-essential clang-tidy cppcheck openjdk-17-jdk npm docker docker-compose libboost-all-dev nodejs libssl-dev libsqlite3-dev clang-format curl rfkill libpcap-dev libevent-dev pkg-config libcap-dev
Please make sure to have `nodejs` installed with minimum version 10.20 for `node_api` version 6+. For updating to a supported version, please follow the install procedure here: `<https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions>`_.

Expand All @@ -79,7 +79,7 @@ Use `zypper` to get your needed libraries installed:
zypper update && zypper install -y sudo shadow
zypper install -y --type pattern devel_basis
zypper install -y git rsync wget cmake doxygen graphviz clang-tools cppcheck boost-devel libboost_filesystem-devel libboost_log-devel libboost_program_options-devel libboost_system-devel libboost_thread-devel java-17-openjdk java-17-openjdk-devel nodejs nodejs-devel npm python3-pip gcc-c++ libopenssl-devel sqlite3-devel libpcap-dev libevent-devel
zypper install -y git rsync wget cmake doxygen graphviz clang-tools cppcheck boost-devel libboost_filesystem-devel libboost_log-devel libboost_program_options-devel libboost_system-devel libboost_thread-devel java-17-openjdk java-17-openjdk-devel nodejs nodejs-devel npm python3-pip gcc-c++ libopenssl-devel sqlite3-devel libpcap-dev libevent-devel libcap-devel
Fedora
------
Expand All @@ -89,7 +89,7 @@ Tested with Fedora 37, 38 and 39. Here is how to get your needed libraries with
.. code-block:: bash
sudo dnf update
sudo dnf install make automake gcc gcc-c++ kernel-devel python3-pip python3-devel git rsync wget cmake doxygen graphviz clang-tools-extra cppcheck java-17-openjdk java-17-openjdk-devel boost-devel nodejs nodejs-devel npm openssl openssl-devel libsqlite3x-devel curl rfkill libpcap-devel libevent-devel
sudo dnf install make automake gcc gcc-c++ kernel-devel python3-pip python3-devel git rsync wget cmake doxygen graphviz clang-tools-extra cppcheck java-17-openjdk java-17-openjdk-devel boost-devel nodejs nodejs-devel npm openssl openssl-devel libsqlite3x-devel curl rfkill libpcap-devel libevent-devel libcap-devel
Now, it's time to continue with the
:ref:`Quick Start Guide to install EVerest <quickstartguide_main>`.
Expand Down
6 changes: 3 additions & 3 deletions docs/latest/appendix/02_snapshot.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ <h3>Navigation</h3>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">928f678</span>
<span class="nt">everest</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">[email protected]:EVerest/EVerest.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40874e16f6d279e9353537de35e26c95a8f1fab1</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2899e25fcb70c6330c346ae2c807480557c219e9</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span>
<span class="nt">everest-core</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">[email protected]:EVerest/everest-core.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4e5f00a052af65d2df64880dcff3b3a4f0752541</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3828a61cb90e5271aaf3b91977b29b537fc905b8</span>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">main</span>
<span class="nt">everest-framework</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/EVerest/everest-framework.git</span>
Expand All @@ -66,7 +66,7 @@ <h3>Navigation</h3>
<span class="w"> </span><span class="nt">git_tag</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a054460</span>
<span class="nt">everest.github.io</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">[email protected]:everest/everest.github.io.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">c847c0f3ad28ece5b797146f2cc7b025c0c171d2</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5c145d2171e2775e58e3e71bd0cff07a633718a2</span>
<span class="nt">ext-mbedtls</span><span class="p">:</span>
<span class="w"> </span><span class="nt">git</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/EVerest/ext-mbedtls.git</span>
<span class="w"> </span><span class="nt">git_rev</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8b3f26a5ac38d4fdccbc5c5366229f3e01dafcc0</span>
Expand Down
6 changes: 3 additions & 3 deletions docs/latest/general/02_detail_pre_setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ <h3><span class="section-number">2.3.1. </span>Ubuntu<a class="headerlink" href=
<p>Tested with Ubuntu 20.04 and 22.04.</p>
<p>Use <cite>apt</cite> to get your needed libraries installed:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>update
sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>python3-pip<span class="w"> </span>git<span class="w"> </span>rsync<span class="w"> </span>wget<span class="w"> </span>cmake<span class="w"> </span>doxygen<span class="w"> </span>graphviz<span class="w"> </span>build-essential<span class="w"> </span>clang-tidy<span class="w"> </span>cppcheck<span class="w"> </span>openjdk-17-jdk<span class="w"> </span>npm<span class="w"> </span>docker<span class="w"> </span>docker-compose<span class="w"> </span>libboost-all-dev<span class="w"> </span>nodejs<span class="w"> </span>libssl-dev<span class="w"> </span>libsqlite3-dev<span class="w"> </span>clang-format<span class="w"> </span>curl<span class="w"> </span>rfkill<span class="w"> </span>libpcap-dev<span class="w"> </span>libevent-dev<span class="w"> </span>pkg-config
sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>python3-pip<span class="w"> </span>git<span class="w"> </span>rsync<span class="w"> </span>wget<span class="w"> </span>cmake<span class="w"> </span>doxygen<span class="w"> </span>graphviz<span class="w"> </span>build-essential<span class="w"> </span>clang-tidy<span class="w"> </span>cppcheck<span class="w"> </span>openjdk-17-jdk<span class="w"> </span>npm<span class="w"> </span>docker<span class="w"> </span>docker-compose<span class="w"> </span>libboost-all-dev<span class="w"> </span>nodejs<span class="w"> </span>libssl-dev<span class="w"> </span>libsqlite3-dev<span class="w"> </span>clang-format<span class="w"> </span>curl<span class="w"> </span>rfkill<span class="w"> </span>libpcap-dev<span class="w"> </span>libevent-dev<span class="w"> </span>pkg-config<span class="w"> </span>libcap-dev
</pre></div>
</div>
<p>Please make sure to have <cite>nodejs</cite> installed with minimum version 10.20 for <cite>node_api</cite> version 6+. For updating to a supported version, please follow the install procedure here: <a class="reference external" href="https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions">https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions</a>.</p>
Expand All @@ -101,7 +101,7 @@ <h3><span class="section-number">2.3.2. </span>OpenSUSE<a class="headerlink" hre
<p>Use <cite>zypper</cite> to get your needed libraries installed:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>zypper<span class="w"> </span>update<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>zypper<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>sudo<span class="w"> </span>shadow
zypper<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>--type<span class="w"> </span>pattern<span class="w"> </span>devel_basis
zypper<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>git<span class="w"> </span>rsync<span class="w"> </span>wget<span class="w"> </span>cmake<span class="w"> </span>doxygen<span class="w"> </span>graphviz<span class="w"> </span>clang-tools<span class="w"> </span>cppcheck<span class="w"> </span>boost-devel<span class="w"> </span>libboost_filesystem-devel<span class="w"> </span>libboost_log-devel<span class="w"> </span>libboost_program_options-devel<span class="w"> </span>libboost_system-devel<span class="w"> </span>libboost_thread-devel<span class="w"> </span>java-17-openjdk<span class="w"> </span>java-17-openjdk-devel<span class="w"> </span>nodejs<span class="w"> </span>nodejs-devel<span class="w"> </span>npm<span class="w"> </span>python3-pip<span class="w"> </span>gcc-c++<span class="w"> </span>libopenssl-devel<span class="w"> </span>sqlite3-devel<span class="w"> </span>libpcap-dev<span class="w"> </span>libevent-devel
zypper<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>git<span class="w"> </span>rsync<span class="w"> </span>wget<span class="w"> </span>cmake<span class="w"> </span>doxygen<span class="w"> </span>graphviz<span class="w"> </span>clang-tools<span class="w"> </span>cppcheck<span class="w"> </span>boost-devel<span class="w"> </span>libboost_filesystem-devel<span class="w"> </span>libboost_log-devel<span class="w"> </span>libboost_program_options-devel<span class="w"> </span>libboost_system-devel<span class="w"> </span>libboost_thread-devel<span class="w"> </span>java-17-openjdk<span class="w"> </span>java-17-openjdk-devel<span class="w"> </span>nodejs<span class="w"> </span>nodejs-devel<span class="w"> </span>npm<span class="w"> </span>python3-pip<span class="w"> </span>gcc-c++<span class="w"> </span>libopenssl-devel<span class="w"> </span>sqlite3-devel<span class="w"> </span>libpcap-dev<span class="w"> </span>libevent-devel<span class="w"> </span>libcap-devel
</pre></div>
</div>
</section>
Expand All @@ -110,7 +110,7 @@ <h3><span class="section-number">2.3.3. </span>Fedora<a class="headerlink" href=
<p>Tested with Fedora 37, 38 and 39. Here is how to get your needed libraries with
<cite>dnf</cite>.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>dnf<span class="w"> </span>update
sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>make<span class="w"> </span>automake<span class="w"> </span>gcc<span class="w"> </span>gcc-c++<span class="w"> </span>kernel-devel<span class="w"> </span>python3-pip<span class="w"> </span>python3-devel<span class="w"> </span>git<span class="w"> </span>rsync<span class="w"> </span>wget<span class="w"> </span>cmake<span class="w"> </span>doxygen<span class="w"> </span>graphviz<span class="w"> </span>clang-tools-extra<span class="w"> </span>cppcheck<span class="w"> </span>java-17-openjdk<span class="w"> </span>java-17-openjdk-devel<span class="w"> </span>boost-devel<span class="w"> </span>nodejs<span class="w"> </span>nodejs-devel<span class="w"> </span>npm<span class="w"> </span>openssl<span class="w"> </span>openssl-devel<span class="w"> </span>libsqlite3x-devel<span class="w"> </span>curl<span class="w"> </span>rfkill<span class="w"> </span>libpcap-devel<span class="w"> </span>libevent-devel
sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>make<span class="w"> </span>automake<span class="w"> </span>gcc<span class="w"> </span>gcc-c++<span class="w"> </span>kernel-devel<span class="w"> </span>python3-pip<span class="w"> </span>python3-devel<span class="w"> </span>git<span class="w"> </span>rsync<span class="w"> </span>wget<span class="w"> </span>cmake<span class="w"> </span>doxygen<span class="w"> </span>graphviz<span class="w"> </span>clang-tools-extra<span class="w"> </span>cppcheck<span class="w"> </span>java-17-openjdk<span class="w"> </span>java-17-openjdk-devel<span class="w"> </span>boost-devel<span class="w"> </span>nodejs<span class="w"> </span>nodejs-devel<span class="w"> </span>npm<span class="w"> </span>openssl<span class="w"> </span>openssl-devel<span class="w"> </span>libsqlite3x-devel<span class="w"> </span>curl<span class="w"> </span>rfkill<span class="w"> </span>libpcap-devel<span class="w"> </span>libevent-devel<span class="w"> </span>libcap-devel
</pre></div>
</div>
<p>Now, it’s time to continue with the
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/nightly/_generated/interfaces/evse_manager.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ <h2><span class="section-number">11.2.15.2. </span>Commands<a class="headerlink"
<div class="line">Enables the evse. EVSE is available for charging after this operation</div>
<div class="line"><strong>connector_id</strong>:<em>integer</em></div>
<div class="line-block">
<div class="line">Specifies the ID of the connector to disable. If 0, the whole EVSE should be enabled</div>
<div class="line">Specifies the ID of the connector to enable. If 0, the whole EVSE should be enabled</div>
</div>
<div class="line"><strong>Result</strong>:<em>boolean</em></div>
<div class="line-block">
Expand Down
5 changes: 5 additions & 0 deletions docs/nightly/_generated/modules/EvseV2G.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ <h2><span class="section-number">11.1.14.1. </span>Module Configuration<a class=
<div class="line-block">
<div class="line">Output directory for the TLS key log file</div>
</div>
<div class="line"><strong>tls_timeout</strong>:<em>integer</em></div>
<div class="line"><em>default: 15000</em></div>
<div class="line-block">
<div class="line">Set the TLS timeout in ms when establishing a tls connection</div>
</div>
<div class="line"><strong>verify_contract_cert_chain</strong>:<em>boolean</em></div>
<div class="line"><em>default: False</em></div>
<div class="line-block">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Commands
| **enable**:*boolean*
| Enables the evse. EVSE is available for charging after this operation
| **connector_id**:*integer*
| Specifies the ID of the connector to disable. If 0, the whole EVSE should be enabled
| Specifies the ID of the connector to enable. If 0, the whole EVSE should be enabled
| **Result**:*boolean*
| Returns true if evse was enabled (or was enabled before), returns false if enable failed e.g. due to permanent fault.
| **disable**:*boolean*
Expand Down
3 changes: 3 additions & 0 deletions docs/nightly/_sources/_generated/modules/EvseV2G.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ Module Configuration
| **tls_key_logging_path**:*string*
| *default: /tmp*
| Output directory for the TLS key log file
| **tls_timeout**:*integer*
| *default: 15000*
| Set the TLS timeout in ms when establishing a tls connection
| **verify_contract_cert_chain**:*boolean*
| *default: False*
| Specifies if the EVSE should verify the contract certificate chain locally.
Expand Down
Loading

0 comments on commit 800dcbe

Please sign in to comment.