Add doc build snapshot nightly

EVerest · Sep 13, 2023 · e44b819 · e44b819
1 parent 0821ab3
commit e44b819
Show file tree

Hide file tree

Showing 10 changed files with 402 additions and 74 deletions.
diff --git a/docs/latest/_sources/hardware/pionix_belay_box.rst.txt b/docs/latest/_sources/hardware/pionix_belay_box.rst.txt
@@ -392,21 +392,113 @@ BelayBox Further Information
 Reference Cheat Sheet
 =====================
 
-* rw: make root partition read/writable
-* ro: make it read only again
-* /mnt/user_data/etc/wpa_supplicant/wpa_supplicant.conf: file containing wifi settings
-* /mnt/user_data/opt/everest/<crosscompiled everest binaries> force the use of custom everest build or config by automated start of ``everest-dev.service`` instead of ``everest.service``
-* /mnt/user_data/etc/update_channel contains either stable or unstable to define release channels
-* /mnt/user_data/etc/wireguard/wg0.conf for a wireguard VPN configuration
-* /mnt/user_data/user-config/config-deploy-devboard.yaml for a persistent user config containing only the diffs to the default config.
-* to stop automatic updates: rw; sudo systemctl disable ota-update.service
-* /mnt/user_data/etc/mosquitto/conf.d: here you can add additional config files for the mqtt broker. For example a “public_mqtt.conf” file with the following contents:
-    ``listener 1883``
-
-    ``allow_anonymous true`` to allow anonymous external connections to the mqtt broker for debugging purposes
-* ``sudo journalctl -fu everest.service``: watch the output of everest.service 
-* ``sudo journalctl -fu everest-dev.service``: watch the output of ``everest-dev.service`` 
-* ``sudo /opt/everest/bin/manager --conf /opt/everest/conf/config-deploy-devboard.yaml``: run EVerest in the terminal. Make sure the systemd service is not running.
+Make root partition read/writable
+---------------------------------
+
+Use the following command:
+
+.. code-block:: bash
+
+  rw
+
+Make it read only again
+-----------------------
+
+Use the following command:
+
+.. code-block:: bash
+
+  ro
+
+File containing wifi settings
+-----------------------------
+.. code-block:: bash
+
+  /mnt/user_data/etc/wpa_supplicant/wpa_supplicant.conf
+
+Use of custom everest build or config
+-------------------------------------
+Force the use of custom everest build or config by automated start of
+``everest-dev.service`` instead of ``everest.service``
+
+.. code-block:: bash
+
+  /mnt/user_data/opt/everest/<crosscompiled everest binaries>
+
+Define release channels
+-----------------------
+Contains either stable or unstable to define release channels:
+
+.. code-block:: bash
+
+  /mnt/user_data/etc/update_channel
+
+Wireguard VPN configuration
+---------------------------
+.. code-block:: bash
+
+  /mnt/user_data/etc/wireguard/wg0.config
+
+Persistent user config
+----------------------
+Via a complete config:
+
+.. code-block:: bash
+
+  /mnt/user_data/etc/everest/custom.yaml
+
+Via a config file containing only the diffs to the default config:
+
+.. code-block:: bash
+
+  /mnt/user_data/user-config/config-deploy-devboard.yaml
+
+Stop automatic updates
+----------------------
+.. code-block:: bash
+
+  rw; sudo systemctl disable ota-update.service
+
+Additional config files for the mqtt broker
+-------------------------------------------
+.. code-block:: bash
+
+  /mnt/user_data/etc/mosquitto/conf.d
+
+This is the place where you can add for example a “public_mqtt.conf” file with the following contents:
+
+.. code-block:: bash
+
+  listener 1883
+  allow_anonymous true
+
+With this, you allow anonymous external connections to the mqtt broker for
+debugging purposes.
+
+Watch the output of everest.service
+-----------------------------------
+
+.. code-block:: bash
+
+  sudo journalctl -fu everest.service
+
+For watching the output of everest-dev.service, set service name to
+*everest-dev.service*.
+
+Run EVerest in terminal
+-----------------------
+
+.. code-block:: bash
+
+  sudo /opt/everest/bin/manager --conf /opt/everest/conf/config-deploy-devboard.yaml
+
+or for using the custom user config:
+
+.. code-block:: bash
+
+  sudo /opt/everest/bin/manager --conf /mnt/user_data/etc/everest/custom.yaml
+
+Make sure the systemd service is not running.
 
 Raspbian partitioning scheme
 ============================

diff --git a/docs/latest/appendix/02_snapshot.html b/docs/latest/appendix/02_snapshot.html
@@ -52,7 +52,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">2023.5.0</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">c029ecc566a59c31b42161bfb47f607549fdd353</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">4485e52725118e374d78cd39fec04eeaeff01769</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>
@@ -68,7 +68,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">v0.1.4</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">e9d52bdf5d8b10c1fd0d4fb1d4291e3ad232674f</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">0821ab32186cea534f9a4603bbc6beeb1c7b0e42</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>
@@ -90,6 +90,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">v0.1.0</span>
 <span class="w">  </span><span class="nt">options</span><span class="p">:</span>
 <span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">BUILD_EXAMPLES OFF</span>
+<span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">CMAKE_POSITION_INDEPENDENT_CODE ON</span>
 <span class="nt">libmodbus</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/libmodbus.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">9d9326f64bceb2b2ea5f73e203c52f95ca62509a</span>

diff --git a/docs/latest/hardware/pionix_belay_box.html b/docs/latest/hardware/pionix_belay_box.html
@@ -333,25 +333,96 @@ <h4><span class="section-number">9.3.1.1. </span>Deploy a custom EVerest on Bela
 <span id="belaybox-furtherinfo"></span><h2><span class="section-number">9.4. </span>BelayBox Further Information<a class="headerlink" href="#belaybox-further-information" title="Permalink to this heading">¶</a></h2>
 <section id="reference-cheat-sheet">
 <h3><span class="section-number">9.4.1. </span>Reference Cheat Sheet<a class="headerlink" href="#reference-cheat-sheet" title="Permalink to this heading">¶</a></h3>
-<ul>
-<li><p>rw: make root partition read/writable</p></li>
-<li><p>ro: make it read only again</p></li>
-<li><p>/mnt/user_data/etc/wpa_supplicant/wpa_supplicant.conf: file containing wifi settings</p></li>
-<li><p>/mnt/user_data/opt/everest/&lt;crosscompiled everest binaries&gt; force the use of custom everest build or config by automated start of <code class="docutils literal notranslate"><span class="pre">everest-dev.service</span></code> instead of <code class="docutils literal notranslate"><span class="pre">everest.service</span></code></p></li>
-<li><p>/mnt/user_data/etc/update_channel contains either stable or unstable to define release channels</p></li>
-<li><p>/mnt/user_data/etc/wireguard/wg0.conf for a wireguard VPN configuration</p></li>
-<li><p>/mnt/user_data/user-config/config-deploy-devboard.yaml for a persistent user config containing only the diffs to the default config.</p></li>
-<li><p>to stop automatic updates: rw; sudo systemctl disable ota-update.service</p></li>
-<li><dl>
-<dt>/mnt/user_data/etc/mosquitto/conf.d: here you can add additional config files for the mqtt broker. For example a “public_mqtt.conf” file with the following contents:</dt><dd><p><code class="docutils literal notranslate"><span class="pre">listener</span> <span class="pre">1883</span></code></p>
-<p><code class="docutils literal notranslate"><span class="pre">allow_anonymous</span> <span class="pre">true</span></code> to allow anonymous external connections to the mqtt broker for debugging purposes</p>
-</dd>
-</dl>
-</li>
-<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">journalctl</span> <span class="pre">-fu</span> <span class="pre">everest.service</span></code>: watch the output of everest.service</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">journalctl</span> <span class="pre">-fu</span> <span class="pre">everest-dev.service</span></code>: watch the output of <code class="docutils literal notranslate"><span class="pre">everest-dev.service</span></code></p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">/opt/everest/bin/manager</span> <span class="pre">--conf</span> <span class="pre">/opt/everest/conf/config-deploy-devboard.yaml</span></code>: run EVerest in the terminal. Make sure the systemd service is not running.</p></li>
-</ul>
+<section id="make-root-partition-read-writable">
+<h4><span class="section-number">9.4.1.1. </span>Make root partition read/writable<a class="headerlink" href="#make-root-partition-read-writable" title="Permalink to this heading">¶</a></h4>
+<p>Use the following command:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>rw
+</pre></div>
+</div>
+</section>
+<section id="make-it-read-only-again">
+<h4><span class="section-number">9.4.1.2. </span>Make it read only again<a class="headerlink" href="#make-it-read-only-again" title="Permalink to this heading">¶</a></h4>
+<p>Use the following command:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ro
+</pre></div>
+</div>
+</section>
+<section id="file-containing-wifi-settings">
+<h4><span class="section-number">9.4.1.3. </span>File containing wifi settings<a class="headerlink" href="#file-containing-wifi-settings" title="Permalink to this heading">¶</a></h4>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/mnt/user_data/etc/wpa_supplicant/wpa_supplicant.conf
+</pre></div>
+</div>
+</section>
+<section id="use-of-custom-everest-build-or-config">
+<h4><span class="section-number">9.4.1.4. </span>Use of custom everest build or config<a class="headerlink" href="#use-of-custom-everest-build-or-config" title="Permalink to this heading">¶</a></h4>
+<p>Force the use of custom everest build or config by automated start of
+<code class="docutils literal notranslate"><span class="pre">everest-dev.service</span></code> instead of <code class="docutils literal notranslate"><span class="pre">everest.service</span></code></p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/mnt/user_data/opt/everest/&lt;crosscompiled<span class="w"> </span>everest<span class="w"> </span>binaries&gt;
+</pre></div>
+</div>
+</section>
+<section id="define-release-channels">
+<h4><span class="section-number">9.4.1.5. </span>Define release channels<a class="headerlink" href="#define-release-channels" title="Permalink to this heading">¶</a></h4>
+<p>Contains either stable or unstable to define release channels:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/mnt/user_data/etc/update_channel
+</pre></div>
+</div>
+</section>
+<section id="wireguard-vpn-configuration">
+<h4><span class="section-number">9.4.1.6. </span>Wireguard VPN configuration<a class="headerlink" href="#wireguard-vpn-configuration" title="Permalink to this heading">¶</a></h4>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/mnt/user_data/etc/wireguard/wg0.config
+</pre></div>
+</div>
+</section>
+<section id="persistent-user-config">
+<h4><span class="section-number">9.4.1.7. </span>Persistent user config<a class="headerlink" href="#persistent-user-config" title="Permalink to this heading">¶</a></h4>
+<p>Via a complete config:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/mnt/user_data/etc/everest/custom.yaml
+</pre></div>
+</div>
+<p>Via a config file containing only the diffs to the default config:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/mnt/user_data/user-config/config-deploy-devboard.yaml
+</pre></div>
+</div>
+</section>
+<section id="stop-automatic-updates">
+<h4><span class="section-number">9.4.1.8. </span>Stop automatic updates<a class="headerlink" href="#stop-automatic-updates" title="Permalink to this heading">¶</a></h4>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>rw<span class="p">;</span><span class="w"> </span>sudo<span class="w"> </span>systemctl<span class="w"> </span>disable<span class="w"> </span>ota-update.service
+</pre></div>
+</div>
+</section>
+<section id="additional-config-files-for-the-mqtt-broker">
+<h4><span class="section-number">9.4.1.9. </span>Additional config files for the mqtt broker<a class="headerlink" href="#additional-config-files-for-the-mqtt-broker" title="Permalink to this heading">¶</a></h4>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/mnt/user_data/etc/mosquitto/conf.d
+</pre></div>
+</div>
+<p>This is the place where you can add for example a “public_mqtt.conf” file with the following contents:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>listener<span class="w"> </span><span class="m">1883</span>
+allow_anonymous<span class="w"> </span><span class="nb">true</span>
+</pre></div>
+</div>
+<p>With this, you allow anonymous external connections to the mqtt broker for
+debugging purposes.</p>
+</section>
+<section id="watch-the-output-of-everest-service">
+<h4><span class="section-number">9.4.1.10. </span>Watch the output of everest.service<a class="headerlink" href="#watch-the-output-of-everest-service" title="Permalink to this heading">¶</a></h4>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>journalctl<span class="w"> </span>-fu<span class="w"> </span>everest.service
+</pre></div>
+</div>
+<p>For watching the output of everest-dev.service, set service name to
+<em>everest-dev.service</em>.</p>
+</section>
+<section id="run-everest-in-terminal">
+<h4><span class="section-number">9.4.1.11. </span>Run EVerest in terminal<a class="headerlink" href="#run-everest-in-terminal" title="Permalink to this heading">¶</a></h4>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>/opt/everest/bin/manager<span class="w"> </span>--conf<span class="w"> </span>/opt/everest/conf/config-deploy-devboard.yaml
+</pre></div>
+</div>
+<p>or for using the custom user config:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>/opt/everest/bin/manager<span class="w"> </span>--conf<span class="w"> </span>/mnt/user_data/etc/everest/custom.yaml
+</pre></div>
+</div>
+<p>Make sure the systemd service is not running.</p>
+</section>
 </section>
 <section id="raspbian-partitioning-scheme">
 <h3><span class="section-number">9.4.2. </span>Raspbian partitioning scheme<a class="headerlink" href="#raspbian-partitioning-scheme" title="Permalink to this heading">¶</a></h3>

diff --git a/docs/latest/objects.inv b/docs/latest/objects.inv
diff --git a/docs/latest/searchindex.js b/docs/latest/searchindex.js