Feature/refactor doc (#23)

Co-authored-by: Thomas Gurriet <tgurriet@3laws.io>
Co-authored-by: Al3LawsRobotics <amoser@3lawsrobotics.com>

.github/workflows/docs.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt-get install -y sed jq git
-          pip install --upgrade sphinx_rtd_theme sphinx docutils sphinx-sitemap sphinxcontrib-spelling pygments breathe sphinx-copybutton
+          pip install --upgrade sphinx_rtd_theme sphinx docutils sphinx-sitemap sphinxcontrib-spelling sphinx-tabs sphinxcontrib-youtube pygments breathe sphinx-copybutton
 
       - uses: actions/checkout@v3
         with:

docs/_templates/versions.html

@@ -1,29 +1,34 @@
-{% if READTHEDOCS or display_lower_left %}
-{# Add rst-badge after rst-versions for small badge style. #}
-<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+{% if READTHEDOCS or display_lower_left %} {# Add rst-badge after rst-versions
+for small badge style. #}
+<div
+  class="rst-versions"
+  data-toggle="rst-versions"
+  role="note"
+  aria-label="versions"
+  style="overflow-y: auto"
+>
   <span class="rst-current-version" data-toggle="rst-current-version">
-    <span class="fa fa-book"> Read the Docs</span>
+    <span class="fa fa-book"> Supervisor Docs </span>
     v: {{ current_version }}
     <span class="fa fa-caret-down"></span>
   </span>
   <div class="rst-other-versions">
     <dl>
-      <dt>{{ _('Versions') }}</dt>
-      {% for slug, the_version in versions_dict.items() %}
-      {% if the_version == current_version %} <strong> {% endif %}
-        <dd><a href="/3laws/en/{{ the_version }}/index.html">{{ the_version }}</a></dd>
+      <dt>{{ _('Versions') }}:</dt>
+      {% for slug, the_version in versions_dict.items() %} {% if the_version ==
+      current_version %}
+      <strong>
+        {% endif %}
+        <dd>
+          <a href="/3laws/en/{{ the_version }}/index.html">{{ the_version }}</a>
+        </dd>
         {% if the_version == current_version %}
-      </strong> {% endif %}
-      {% endfor %}
+      </strong>
+      {% endif %} {% endfor %}
     </dl>
-    <dl>
-      <dt>Downloads</dt>
-      <dd><a href="/3laws/en/{{ current_version }}/3laws_manual.pdf">PDF</a></dd>
-    </dl>
-    <hr />
-    {% trans %}Continuous documentation hosting provided by <a href="https://pages.github.com/">GitHub Pages</a>.{%
-    endtrans %}
-
+    <hr style="margin: 5px" />
+    {% trans %}Continuous documentation hosting provided by
+    <a href="https://pages.github.com/">GitHub Pages</a>.{% endtrans %}
   </div>
 </div>
-{% endif %}
+{% endif %}

docs/build_local.sh

@@ -11,7 +11,7 @@ srcDir="$(
 version="latest"
 
 # Clean output directory
-rm -rf "$srcDir/.gh-pages"
+# rm -rf "$srcDir/.gh-pages"
 rm -rf "$srcDir/build"
 
 # Create output directory

docs/conf.py

@@ -35,17 +35,20 @@
 release = current_version
 html_baseurl = "https://3lawsrobotics.github.io/3laws/"
 
-
 extensions = [
     "sphinx_rtd_theme",
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx.ext.githubpages",
     "sphinx_sitemap",
     "sphinx_copybutton",
+    "sphinxcontrib.youtube",
+    "sphinx_tabs.tabs",
 ]
 
+html_show_sphinx = False
 html_show_sourcelink = False
+sphinx_tabs_disable_tab_closing = True
 
 templates_path = ["_templates"]
 html_static_path = ["_static"]

docs/index.rst

@@ -1,23 +1,39 @@
-.. 3Laws documentation master file, created by
-   sphinx-quickstart on Fri Sep 30 02:43:43 2022.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. Please use:
+.. * ``#``, for page title
+.. * ``=``, for sections
+.. * ``-``, for subsections
+.. * ``^``, for sub-subsections
+.. * ``"``, for paragraphs
+.. Please indent the text with 2 spaces.
+
+
 
 Welcome to 3Laws Supervisor
-=================================
+###########################
 
-The 3Laws Supervisor is a tool that runs on your robot(s) and can optionally
-transmit data to a cloud-based dashboard. 
+Welcome to using the **3Laws Supervisor**, a next-generation software-based failsafe system providing trustworthy sense-and-avoid capabilities for a variety of robotic platforms.
 
-.. toctree::
-   :maxdepth: 3
+.. _contact 3Laws: mailto:sales@3laws.io
 
-   sources/introduction
-   sources/usage
-   sources/visualization/index
-   sources/theory
-   sources/copyrights
-   sources/dpa
+The **3Laws Supervisor** is designed to be an easy-to-use tool for developers to quickly integrate sense-and-avoid capabilities into their robotic platforms. The **3Laws Supervisor** encapsulate only a subset of the technological capabilities offered by **3Laws**.
 
+`Contact 3Laws`_ for information on extended and optimized Supervisor capabilities.
 
+Other relevant resources:
+=========================
+* `3Laws Website <https://3laws.io>`_: For information about our other products and offerings.
+* `3Laws Github <https://github.com/3LawsRobotics/3laws>`_: For releases and issue tracking.
+
+
+.. toctree::
+  :hidden:
+  :titlesonly:
+  :maxdepth: 3
 
+  sources/getting_started
+  sources/user_guide
+  sources/troubleshooting
+  sources/faq
+  sources/knowledge
+  sources/changelog
+  sources/legal

docs/sources/changelog.rst

@@ -0,0 +1,30 @@
+Change Log
+##########
+
+.. contents::
+  :local:
+
+This project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
+
+1.0.0 (1st May 2024)
+=====================
+
+This is the first version of the supervisor product.
+
+Added
+------
+
+- A ROS node that perform out of the box collision avoidance for any simple robot that has a lidar or an obstacle map.
+- A Control Panel as a web server running on the robot to configure the supervisor and provide realtime feedback.
+- A Command Line Client to manage the Control Panel server and check for updates.
+- A documentation available `here <https://3lawsrobotics.github.io/3laws/en/latest/>`_.
+
+Changed
+--------
+
+N/A
+
+Removed
+--------
+
+N/A