Minor docs update

VlasovAlexey · Aug 22, 2024 · a0f0201 · a0f0201
1 parent 27ee513
commit a0f0201
Show file tree

Hide file tree

Showing 14 changed files with 39 additions and 30 deletions.
diff --git a/doc/.doctrees/environment.pickle b/doc/.doctrees/environment.pickle
diff --git a/doc/.doctrees/general/project_info.doctree b/doc/.doctrees/general/project_info.doctree
diff --git a/doc/.doctrees/index.doctree b/doc/.doctrees/index.doctree
diff --git a/doc/_images/body_01.jpg b/doc/_images/body_01.jpg
diff --git a/doc/_images/body_02.jpg b/doc/_images/body_02.jpg
diff --git a/doc/_sources/general/project_info.rst.txt b/doc/_sources/general/project_info.rst.txt
@@ -3,4 +3,10 @@ Project global information
 
 .. figure:: /hardware/res/body_01.jpg
     :width: 80%
-    :align: center
+    :align: center
+
+
+.. Warning::
+    WARNING! THERE IS ALWAYS A RISK OF DECOMPRESSION SICKNESS (DCS) FOR ANY DIVE PROFILE EVEN IF YOU FOLLOW THE DIVE PLAN PRESCRIBED BY DIVE TABLES. NO PROCEDURE OR DIVE TABLE WILL PREVENT THE POSSIBILITY OF DCS OR OXYGEN TOXICITY! An individual’s physiological make up can vary from day to day. You are strongly advised to remain well within the exposure limits provided by the DIVE COMPUTER to minimize the risk of DCS.
+
+    Please note - this program is made with the experienced and technical diver in mind. If you're relatively new to diving, you may find this program difficult to use. You're expected to know the theory behind the diving practices and procedures used here.
diff --git a/doc/_sources/index.rst.txt b/doc/_sources/index.rst.txt
@@ -6,8 +6,13 @@
 Welcome to Dive Computer documentation!
 ========================================
 
-DIVE COMPUTER is an open platform for professional divers. Devices based on this platform can be used for a wide variety of diver needs.
-The DIVE COMPUTER platform is integrated into the popular DiveProMe and Minotaur Cave Survey Software.
+DIVE COMPUTER is an open platform for professional and recreational certifed divers. Devices based on this platform can be used for a wide variety of diver needs.
+The DIVE COMPUTER platform is integrated into the popular `DiveProMe <https://vlasovalexey.github.io/DiveProMe/HTML_SRC/>`_ and `Minotaur <https://github.com/VlasovAlexey/Minotaur>`_ Cave Survey Software.
+
+
+.. figure:: /hardware/res/body_01.jpg
+    :width: 80%
+    :align: center
 
 .. toctree::
     :maxdepth: 3
@@ -49,10 +54,3 @@ The DIVE COMPUTER platform is integrated into the popular DiveProMe and Minotaur
     usages/examples
     usages/prototypes
     usages/underwater_operation
-
-Indices and tables
-==================
-
-
-* :ref:`genindex`
-* :ref:`search`
diff --git a/doc/general/project_info.html b/doc/general/project_info.html
@@ -117,6 +117,11 @@ <h1><span class="section-number">2. </span>Project global information<a class="h
 <figure class="align-center">
 <a class="reference internal image-reference" href="../_images/body_01.jpg"><img alt="../_images/body_01.jpg" src="../_images/body_01.jpg" style="width: 80%;" /></a>
 </figure>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>WARNING! THERE IS ALWAYS A RISK OF DECOMPRESSION SICKNESS (DCS) FOR ANY DIVE PROFILE EVEN IF YOU FOLLOW THE DIVE PLAN PRESCRIBED BY DIVE TABLES. NO PROCEDURE OR DIVE TABLE WILL PREVENT THE POSSIBILITY OF DCS OR OXYGEN TOXICITY! An individual’s physiological make up can vary from day to day. You are strongly advised to remain well within the exposure limits provided by the DIVE COMPUTER to minimize the risk of DCS.</p>
+<p>Please note - this program is made with the experienced and technical diver in mind. If you’re relatively new to diving, you may find this program difficult to use. You’re expected to know the theory behind the diving practices and procedures used here.</p>
+</div>
 </section>
 
 

diff --git a/doc/index.html b/doc/index.html
@@ -113,8 +113,11 @@
 
   <section id="welcome-to-dive-computer-documentation">
 <h1>Welcome to Dive Computer documentation!<a class="headerlink" href="#welcome-to-dive-computer-documentation" title="Permalink to this heading"></a></h1>
-<p>DIVE COMPUTER is an open platform for professional divers. Devices based on this platform can be used for a wide variety of diver needs.
-The DIVE COMPUTER platform is integrated into the popular DiveProMe and Minotaur Cave Survey Software.</p>
+<p>DIVE COMPUTER is an open platform for professional and recreational certifed divers. Devices based on this platform can be used for a wide variety of diver needs.
+The DIVE COMPUTER platform is integrated into the popular <a class="reference external" href="https://vlasovalexey.github.io/DiveProMe/HTML_SRC/">DiveProMe</a> and <a class="reference external" href="https://github.com/VlasovAlexey/Minotaur">Minotaur</a> Cave Survey Software.</p>
+<figure class="align-center">
+<a class="reference internal image-reference" href="_images/body_01.jpg"><img alt="_images/body_01.jpg" src="_images/body_01.jpg" style="width: 80%;" /></a>
+</figure>
 <div class="toctree-wrapper compound">
 </div>
 <div class="toctree-wrapper compound">
@@ -123,13 +126,6 @@ <h1>Welcome to Dive Computer documentation!<a class="headerlink" href="#welcome-
 </div>
 <div class="toctree-wrapper compound">
 </div>
-</section>
-<section id="indices-and-tables">
-<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h1>
-<ul class="simple">
-<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
-<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
-</ul>
 </section>
 
 

diff --git a/doc/searchindex.js b/doc/searchindex.js
diff --git a/doc_src/general/project_info.rst b/doc_src/general/project_info.rst
@@ -3,4 +3,10 @@ Project global information
 
 .. figure:: /hardware/res/body_01.jpg
     :width: 80%
-    :align: center
+    :align: center
+
+
+.. Warning::
+    WARNING! THERE IS ALWAYS A RISK OF DECOMPRESSION SICKNESS (DCS) FOR ANY DIVE PROFILE EVEN IF YOU FOLLOW THE DIVE PLAN PRESCRIBED BY DIVE TABLES. NO PROCEDURE OR DIVE TABLE WILL PREVENT THE POSSIBILITY OF DCS OR OXYGEN TOXICITY! An individual’s physiological make up can vary from day to day. You are strongly advised to remain well within the exposure limits provided by the DIVE COMPUTER to minimize the risk of DCS.
+
+    Please note - this program is made with the experienced and technical diver in mind. If you're relatively new to diving, you may find this program difficult to use. You're expected to know the theory behind the diving practices and procedures used here.
diff --git a/doc_src/hardware/res/body_01.jpg b/doc_src/hardware/res/body_01.jpg
diff --git a/doc_src/hardware/res/body_02.jpg b/doc_src/hardware/res/body_02.jpg
diff --git a/doc_src/index.rst b/doc_src/index.rst
@@ -6,8 +6,13 @@
 Welcome to Dive Computer documentation!
 ========================================
 
-DIVE COMPUTER is an open platform for professional divers. Devices based on this platform can be used for a wide variety of diver needs.
-The DIVE COMPUTER platform is integrated into the popular DiveProMe and Minotaur Cave Survey Software.
+DIVE COMPUTER is an open platform for professional and recreational certifed divers. Devices based on this platform can be used for a wide variety of diver needs.
+The DIVE COMPUTER platform is integrated into the popular `DiveProMe <https://vlasovalexey.github.io/DiveProMe/HTML_SRC/>`_ and `Minotaur <https://github.com/VlasovAlexey/Minotaur>`_ Cave Survey Software.
+
+
+.. figure:: /hardware/res/body_01.jpg
+    :width: 80%
+    :align: center
 
 .. toctree::
     :maxdepth: 3
@@ -49,10 +54,3 @@ The DIVE COMPUTER platform is integrated into the popular DiveProMe and Minotaur
     usages/examples
     usages/prototypes
     usages/underwater_operation
-
-Indices and tables
-==================
-
-
-* :ref:`genindex`
-* :ref:`search`