Docs improvements

MRPT · Jul 11, 2023 · d36b431 · d36b431
1 parent 1ea114b
commit d36b431
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 34 deletions.
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,5 +1,5 @@
 sphinx_rtd_theme
-sphinx-panels
+sphinx_design
 sphinxcontrib-bibtex
 mistune<2.0.0
 m2r2
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -42,7 +42,7 @@
     'sphinx.ext.graphviz',
     'doxyrest',
     'cpplexer',
-    'sphinx_panels',
+    'sphinx_design',
     'sphinxcontrib.bibtex',
     'm2r2',  # provides: mdinclude
 ]
@@ -81,7 +81,7 @@
 language = 'en'
 
 # Allow Sphinx to find images under the "images" path:
-figure_language_filename='images/{path}/{basename}{ext}'
+figure_language_filename = 'images/{path}/{basename}{ext}'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/doc/source/download-mrpt.rst b/doc/source/download-mrpt.rst
@@ -4,58 +4,62 @@
 Download MRPT
 ##############
 
-.. contents:: :local:
+.. .. contents:: :local:
 
 
-Source code
--------------
+.. dropdown:: Source code
+    :icon: code
+    :open:
 
-Get the latest development version from the official
-`MRPT GitHub repository <https://github.com/MRPT/mrpt/>`_ with:
+    Get the latest development version from the official
+    `MRPT GitHub repository <https://github.com/MRPT/mrpt/>`_ with:
 
-.. code-block:: bash
+    .. code-block:: bash
 
-   git clone https://github.com/MRPT/mrpt.git --recursive
+       git clone https://github.com/MRPT/mrpt.git --recursive
 
-Next step: :ref:`compiling`
+    Next step: :ref:`compiling`
 
-Debian/Ubuntu official repositories
----------------------------------------
 
-Install the `official version <https://packages.ubuntu.com/source/jammy/mrpt>`_ for your distribution with:
+.. dropdown:: Debian/Ubuntu official repositories
+   :icon: code-square
 
-.. code-block:: bash
+    Install the `official version <https://packages.ubuntu.com/source/jammy/mrpt>`_ for your distribution with:
 
-   sudo apt install libmrpt-dev mrpt-apps
+    .. code-block:: bash
 
+       sudo apt install libmrpt-dev mrpt-apps
 
-.. note::
-   Versions in `official repositories <https://packages.ubuntu.com/source/jammy/mrpt>`_
-   may be quite outdated. It is strongly
-   recommended to use the PPAs (read below) or build from sources instead.
 
+    .. note::
+       Versions in `official repositories <https://packages.ubuntu.com/source/jammy/mrpt>`_
+       may be quite outdated. It is strongly
+       recommended to use the PPAs (read below) or build from sources instead.
 
-Debian/Ubuntu PPA
-----------------------
 
-Last **stable release** (`mrpt-stable PPA status <https://launchpad.net/~joseluisblancoc/+archive/ubuntu/mrpt-stable>`_) (from the ``master`` branch), for Ubuntu >=18.04:
+.. dropdown:: Debian/Ubuntu PPA
+    :icon: code-square
 
-.. code-block:: bash
+    Last **stable release** (`mrpt-stable PPA status <https://launchpad.net/~joseluisblancoc/+archive/ubuntu/mrpt-stable>`_) (from the ``master`` branch), for Ubuntu >=18.04:
 
-   sudo add-apt-repository ppa:joseluisblancoc/mrpt-stable   # master (stable releases) branch
-   sudo apt install libmrpt-dev mrpt-apps
+    .. code-block:: bash
 
-**Nightly builds** (`mrpt-nightly PPA status <https://launchpad.net/~joseluisblancoc/+archive/ubuntu/mrpt>`_) (from the ``develop`` branch) for Ubuntu >=18.04:
+       sudo add-apt-repository ppa:joseluisblancoc/mrpt-stable   # master (stable releases) branch
+       sudo apt install libmrpt-dev mrpt-apps  # C++ libs + apps
+       sudo apt install python3-pymrpt  # for the Python package
 
-.. code-block:: bash
+    **Nightly builds** (`mrpt-nightly PPA status <https://launchpad.net/~joseluisblancoc/+archive/ubuntu/mrpt>`_) (from the ``develop`` branch) for Ubuntu >=18.04:
 
-   sudo add-apt-repository ppa:joseluisblancoc/mrpt   # develop branch
-   sudo apt install libmrpt-dev mrpt-apps
+    .. code-block:: bash
 
+       sudo add-apt-repository ppa:joseluisblancoc/mrpt   # develop branch
+       sudo apt install libmrpt-dev mrpt-apps  # C++ libs + apps
+       sudo apt install python3-pymrpt  # for the Python package
 
-Windows installers
---------------------
 
-Executables (.exes and .dlls) and development libraries (.hs and .libs) included:
+.. dropdown:: Windows installers
+    :icon: desktop-download
 
-   - `Nightly builds <https://github.com/MRPT/mrpt/releases/tag/Windows-nightly-builds>`_
+    Executables (.exes and .dlls) and development libraries (.hs and .libs) included:
+
+       - `Nightly builds <https://github.com/MRPT/mrpt/releases/tag/Windows-nightly-builds>`_
diff --git a/doc/source/python_examples.rst b/doc/source/python_examples.rst
@@ -14,6 +14,7 @@ C++ examples are `here <examples.html>`_.
 
 .. toctree::
   :maxdepth: 1
+  :hidden:
 
   pymrpt_example_global_localization.rst
   pymrpt_example_hwdriver_tao_imu_usb.rst
@@ -24,3 +25,57 @@ C++ examples are `here <examples.html>`_.
   pymrpt_example_ros-poses-convert.rst
   pymrpt_example_se2-poses-example.rst
   pymrpt_example_se3-poses-example.rst
+
+
+.. grid:: 2
+    :gutter: 1
+
+    .. grid-item-card:: Particle filter localization
+
+        .. image:: https://i3.ytimg.com/vi/ZfVUydQIM5E/hqdefault.jpg
+           :target: pymrpt_example_global_localization.html
+           :width: 200px
+
+    .. grid-item-card:: SLAM: classic grid mapping
+
+        .. image:: https://i3.ytimg.com/vi/XiKTWNOQlcU/hqdefault.jpg
+           :target: pymrpt_example_rbpf_slam.html
+           :width: 200px
+
+.. grid:: 2
+    :gutter: 1
+
+    .. grid-item-card:: Reading USB TaoIMU sensor
+
+        .. image:: https://i3.ytimg.com/vi/qaaP9BmZYmo/hqdefault.jpg
+           :target: pymrpt_example_hwdriver_tao_imu_usb.html
+           :width: 200px
+
+    .. grid-item-card:: OpenGL
+
+        .. image:: https://mrpt.github.io/imgs/screenshot_pymrpt_example_opengl1.png
+           :target: pymrpt_example_opengl-demo-gui.html
+           :width: 200px
+
+.. grid:: 2
+    :gutter: 1
+
+    .. grid-item-card:: Geometry
+
+        :ref:`pyexample_lines-3d-geometry-example`
+
+    .. grid-item-card:: Geometry
+
+        :ref:`pyexample_se2-poses-example`
+
+.. grid:: 2
+    :gutter: 1
+
+    .. grid-item-card:: Geometry
+
+        :ref:`pyexample_se3-poses-example`
+
+    .. grid-item-card:: Matrices and Algebra
+
+        :ref:`pyexample_matrices`
+