Changes in the user guide layout

doc/source/user_guide/concepts/index.rst

@@ -1,44 +1,28 @@
-.. _ref_concepts:
+.. _ref_concepts_index:
 
-========
 Concepts
-========
+--------
 
-This section provides in-depth descriptions and explanations of DPF concepts, including terminology.
+.. grid:: 3
+    :gutter: 2
 
-DPF concepts
-~~~~~~~~~~~~
-
-.. toctree::
-   :hidden:
-
-   concepts.rst
-   waysofusing.rst
-   stepbystep.rst
-
-
-.. card-carousel:: 2
-
-    .. card:: Concepts and terminology
+    .. grid-item-card:: Concepts and terminology
        :link: user_guide_concepts
        :link-type: ref
-       :width: 25%
        :text-align: center
 
        .. image:: ../images/drawings/book-logo.png
 
-    .. card:: Ways of using DPF
+    .. grid-item-card:: Ways of using DPF
        :link: user_guide_waysofusing
        :link-type: ref
-       :width: 25%
        :text-align: center
 
        .. image:: ../images/drawings/using-dpf.png
 
-    .. card:: Using DPF: Step by step
+    .. grid-item-card:: Using DPF: Step by step
        :link: user_guide_stepbystep
        :link-type: ref
-       :width: 25%
        :text-align: center
 
-       .. image:: ../images/drawings/checklist.png
+       .. image:: ../images/drawings/checklist.png

doc/source/user_guide/custom_operators.rst → doc/source/user_guide/how-to/custom_operators.rst

@@ -34,8 +34,8 @@ installer's Python interpreter.
 
 #. Download the script for you operating system:
 
-   - For Windows, download this :download:`PowerShell script </user_guide/install_ansys_dpf_core_in_ansys.ps1>`.
-   - For Linux, download this :download:`Shell script </user_guide/install_ansys_dpf_core_in_ansys.sh>`
+   - For Windows, download this :download:`PowerShell script </user_guide/how-to/install_ansys_dpf_core_in_ansys.ps1>`.
+   - For Linux, download this :download:`Shell script </user_guide/how-to/install_ansys_dpf_core_in_ansys.sh>`
 
 #. Run the downloaded script for installing with optional arguments:
 
@@ -48,8 +48,8 @@ If you ever want to uninstall the ``ansys-dpf-core`` module from the Ansys insta
 
 #. Download the script for your operating system:
 
-   - For Windows, download this :download:`PowerShell script </user_guide/uninstall_ansys_dpf_core_in_ansys.ps1>`.
-   - For Linux, download this :download:`Shell script </user_guide/uninstall_ansys_dpf_core_in_ansys.sh>`.
+   - For Windows, download this :download:`PowerShell script </user_guide/how-to/uninstall_ansys_dpf_core_in_ansys.ps1>`.
+   - For Linux, download this :download:`Shell script </user_guide/how-to/uninstall_ansys_dpf_core_in_ansys.sh>`.
 
 3. Run the downloaded script for uninstalling with the optional argument:
 

doc/source/user_guide/custom_operators_deps.rst → doc/source/user_guide/how-to/custom_operators_deps.rst

@@ -23,8 +23,8 @@ For this approach, do the following:
 
 #. Download the script for your operating system:
 
-   - For Windows, download this :download:`PowerShell script </user_guide/create_sites_for_python_operators.ps1>`.
-   - For Linux, download this :download:`Shell script </user_guide/create_sites_for_python_operators.sh>`.
+   - For Windows, download this :download:`PowerShell script </user_guide/how-to/create_sites_for_python_operators.ps1>`.
+   - For Linux, download this :download:`Shell script </user_guide/how-to/create_sites_for_python_operators.sh>`.
 
 3. Run the downloaded script with the mandatory arguments:
 

doc/source/user_guide/how_to.rst → doc/source/user_guide/how-to/index.rst

@@ -1,73 +1,47 @@
 .. _ref_how_to:
 
-How-tos
-~~~~~~~
+Accessing and enriching DPF capabilities
+----------------------------------------
 
-.. toctree::
-    :hidden:
+.. grid:: 3
+    :gutter: 2
 
-    plotting.rst
-    custom_operators.rst
-    dpf_server.rst
-    server_types.rst
-    server_context.rst
-    xmlfiles.rst
-
-
-.. card-carousel:: 2
-
-    .. card:: Plot
-       :link: user_guide_plotting
-       :link-type: ref
-       :width: 25%
-       :text-align: center
-
-       .. image:: ../images/plotting/pontoon.png
-       .. image:: ../images/plotting/pontoon_strain.png
-
-
-    .. card:: Create custom operators
+    .. grid-item-card:: Create custom operators
        :link: user_guide_custom_operators
        :link-type: ref
-       :width: 25%
        :text-align: center
 
        .. image:: ../images/drawings/plugin-logo.png
           :width: 50%
 
 
-    .. card:: Use DPF Server package
+    .. grid-item-card:: Use DPF Server package
        :link: ref_dpf_server
        :link-type: ref
-       :width: 25%
        :text-align: center
 
        .. image:: ../images/drawings/dpf_server_client.png
 
 
-.. card-carousel:: 2
-
-    .. card:: Switch between local and remote server
+    .. grid-item-card:: Switch between local and remote server
        :link: user_guide_server_types
        :link-type: ref
-       :width: 25%
        :text-align: center
 
        .. image:: ../images/drawings/remote_machines.png
 
-    .. card:: Access Entry and Premium capabilities
+
+    .. grid-item-card:: Access Entry and Premium capabilities
        :link: user_guide_server_context
        :link-type: ref
-       :width: 25%
        :text-align: center
 
        .. image:: ../images/drawings/entry_premium.png
 
 
-    .. card:: Use DPF XML Files
+    .. grid-item-card:: Use DPF XML Files
        :link: user_guide_xmlfiles
        :link-type: ref
-       :width: 25%
        :text-align: center
 
        .. image:: ../images/drawings/xml.png

doc/source/user_guide/index.rst

@@ -13,16 +13,51 @@ The goals of this section are to:
  - Describe the most-used DPF entities and how they can help you to access and modify solver data.
  - Provide simple how-tos for tackling the most common use cases.
 
+.. include::
+   concepts/index.rst
+
+.. include::
+   tutorials/index.rst
 
 .. include::
-   main_entities.rst
+   how-to/index.rst
 
 .. include::
-   how_to.rst
+   troubleshooting/index.rst
+
+
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+    :caption: Concepts
 
+    concepts/concepts.rst
+    concepts/waysofusing.rst
+    concepts/stepbystep.rst
 
-Troubleshooting
-~~~~~~~~~~~~~~~
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+    :caption: Tutorials
+
+    tutorials/model.rst
+    tutorials/operators.rst
+    tutorials/fields_container.rst
+
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+    :caption: Accessing and enriching DPF capabilities
+
+    how-to/plotting.rst
+    how-to/custom_operators.rst
+    how-to/server_context.rst
+    how-to/server_types.rst
+    how-to/xmlfiles.rst
 
 .. toctree::
-   troubleshooting
+    :maxdepth: 1
+    :hidden:
+    :caption: Troubleshooting
+
+    troubleshooting/troubleshooting.rst

doc/source/user_guide/troubleshooting/index.rst

@@ -0,0 +1,39 @@
+.. _ref_troubleshooting_index:
+
+Troubleshooting
+---------------
+
+.. grid:: 3
+    :gutter: 2
+
+    .. grid-item-card:: Server issues
+       :link: ref_server_issues
+       :link-type: ref
+       :text-align: center
+
+       Start the DPF server
+
+       Connect to the DPF server
+
+       Import the pydpf-core package
+
+    .. grid-item-card:: Model issues
+       :link: ref_model_issues
+       :link-type: ref
+       :text-align: center
+
+       Invalid UTF-8 error
+
+    .. grid-item-card::  Plotting issues
+       :link: ref_plotting_issues
+       :link-type: ref
+       :text-align: center
+
+    .. grid-item-card::  Performance issues
+       :link: ref_performance_issues
+       :link-type: ref
+       :text-align: center
+
+       Get and set a field's data
+
+       Autocompletion in notebooks

doc/source/user_guide/troubleshooting.rst → doc/source/user_guide/troubleshooting/troubleshooting.rst

@@ -3,11 +3,15 @@
 ===============
 Troubleshooting
 ===============
+
 This page explains how to resolve the most common issues encountered when
 using PyDPF-Core. It also includes suggestions for improving scripts.
 
+.. _ref_server_issues:
+
+==============
 Server issues
--------------
+==============
 
 Start the DPF server
 ~~~~~~~~~~~~~~~~~~~~~
@@ -38,8 +42,11 @@ If an error lists missing modules, see :ref:`ref_compatibility`.
 For ``PyDPF-Core``<0.10.0, the `ansys.grpc.dpf <https://pypi.org/project/ansys-grpc-dpf/>`_ module
 should always be synchronized with its server version.
 
+.. _ref_model_issues:
+
+============
 Model issues
-------------
+============
 
 Invalid UTF-8 error
 ~~~~~~~~~~~~~~~~~~~
@@ -66,8 +73,11 @@ Then, with result files reproducing this issue, you can prevent the warning from
 However, the preceding code disables the reading and generation of the available results for the model.
 Any static results that are available for the model are used instead.
 
+.. _ref_plotting_issues:
+
+===============
 Plotting issues
----------------
+===============
 
 When trying to plot a result with DPF, the following error might be raised:
 
@@ -84,8 +94,11 @@ In that case, simply install `PyVista <https://pyvista.org/>`_` with this comman
 Another option is to install PyVista along with PyDPF-Core. For more information, see 
 :ref:`Install with plotting capabilities<target_to_install_with_plotting_capabilities>`
 
+.. _ref_performance_issues:
+
+==================
 Performance issues
-------------------
+==================
 
 Get and set a field's data
 ~~~~~~~~~~~~~~~~~~~~~~~~~~