New tutorials section

doc/source/_static/custom.css

@@ -2,3 +2,15 @@
 .wy-table-responsive table td, .wy-table-responsive table th {
     white-space: normal;
 }
+/* Check https://www.w3schools.com/cssref/css_colors.php for colors */
+/* Ansys gold for MAPDL with black text*/
+.sd-bg-mapdl{background-color: #FFB71B}
+.sd-bg-text-mapdl{color: Black}
+/* Ansys orange accent color for Fluent with black text*/
+.sd-bg-lsdyna{background-color: #FB471F}
+.sd-bg-text-lsdyna{color: Black}
+/* Ansys blue accent color #00629F for Fluent with black text*/
+.sd-bg-fluent{background-color: #0081D0}
+.sd-bg-text-fluent{color: Black}
+.sd-bg-cfx{background-color: LightSeaGreen}
+.sd-bg-text-cfx{color: Black}

doc/source/conf.py

@@ -87,6 +87,7 @@
     "sphinx_design",
     "sphinx_gallery.gen_gallery",
     'sphinx_reredirects',
+    "jupyter_sphinx",
 ]
 
 redirects = {
@@ -323,3 +324,17 @@ def reset_servers(gallery_conf, fname, when):
 
 # A list of files that should not be packed into the epub file.
 epub_exclude_files = ["search.html"]
+
+# Define custom docutils roles for solver badges
+from sphinx_design.badges_buttons import BadgeRole
+
+def setup(app):
+    badge_roles = {
+        "bdg-mapdl": "mapdl",
+        "bdg-cfx": "cfx",
+        "bdg-fluent": "fluent",
+        "bdg-lsdyna": "lsdyna"
+    }
+
+    for role_name, color in badge_roles.items():
+        app.add_role(name=role_name, role=BadgeRole(color=color))

doc/source/links_and_refs.rst

@@ -0,0 +1,46 @@
+.. _ref_links_and_refs:
+
+.. LINKS
+
+.. Pyansys
+.. _pyansys: https://docs.pyansys.com/version/dev/
+
+.. PyAnsys Developer Guide
+.. _dev_guide_pyansys: https://dev.docs.pyansys.com
+.. _dev_guide_contributing: https://dev.docs.pyansys.com/how-to/contributing.html
+.. _dev_guide_coding_style: https://dev.docs.pyansys.com/coding-style/index.html
+.. _dev_guide_setup_your_environment: https://dev.docs.pyansys.com/how-to/setting-up.html
+.. _dev_guide_branch_names: https://dev.docs.pyansys.com/how-to/contributing.html#branch-naming-conventions
+.. _dev_guide_commit_names: https://dev.docs.pyansys.com/how-to/contributing.html#commit-naming-conventions
+
+.. Other libraries
+.. _pyvista_docs: https://docs.pyvista.org/version/stable/
+.. _jupyter: https://jupyter.org/
+.. _numpy_org: https://numpy.org/
+.. _numpy_docs: https://numpy.org/doc/stable/
+
+.. External links
+.. _sphinx: https://www.sphinx-doc.org/en/master/
+.. _sphinx_directives: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
+.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/
+.. _vale: https://www.vale.sh
+.. _docutils_directives: https://docutils.sourceforge.io/docs/ref/rst/directives.html
+
+.. REFERENCES
+
+.. Main DPF objects
+.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
+.. |Field| replace:: :class:`Field<ansys.dpf.core.field.Field>`
+.. |FieldsContainer| replace:: :class:`FieldsContainer<ansys.dpf.core.fields_container.FieldsContainer>`
+.. |Model| replace:: :class:`Model <ansys.dpf.core.model.Model>`
+.. |DataSources| replace:: :class:`Model <ansys.dpf.core.data_sources.DataSources>`
+.. |Scoping| replace:: :class:`Scoping <ansys.dpf.core.scoping.Scoping>`
+.. |MeshedRegion| replace:: :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>`
+.. |MeshInfo| replace:: :class:`MeshInfo <ansys.dpf.core.mesh_info.MeshInfo>`
+.. |Nodes| replace:: :class:`Nodes <ansys.dpf.core.nodes.Nodes>`
+.. |Elements| replace:: :class:`Elements <ansys.dpf.core.elements.Elements>`
+.. |Faces| replace:: :class:`Faces <ansys.dpf.core.faces.Faces>`
+.. |DpfPlotter| replace:: :class:`DpfPlotter<ansys.dpf.core.plotter.DpfPlotter>`
+.. |Result| replace:: :class:`Result <ansys.dpf.core.results.Result>`
+.. |Operator| replace:: :class:`Operator<ansys.dpf.core.dpf_operator.Operator>`
+.. |TimeFreqSupport| replace:: :class:`TimeFreqSupport <ansys.dpf.core.time_freq_support.TimeFreqSupport>`

doc/source/user_guide/index.rst

@@ -4,24 +4,24 @@
 User guide
 ==========
 
-PyDPF-Core is a Python client API for accessing DPF postprocessing
-capabilities. The ``ansys.dpf.core`` package makes highly efficient 
-computation, customization, and remote postprocessing accessible in Python.
+**DPF** provides numerical simulation users and engineers with a toolbox for accessing and
+transforming data.
 
-The goals of this section are to:
+**PyDPF-Core** is a Python client API for accessing DPF
+capabilities. The ``ansys.dpf.core`` package makes highly efficient
+computation, customization, and remote data processing accessible in Python.
 
- - 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.
+The goals of this section are to:
 
-.. include::
-   concepts/index.rst
+ - Describe some DPF entities and how they can help you to access and modify solver data.
+ - Provide detailed tutorials to demonstrate PyDPF-Core functionalities.
+ - Explain how to resolve the most common issues encountered when using PyDPF-Core
 
 .. include::
-   main_entities.rst
+   tutorials/index.rst
 
 .. include::
-   how_to.rst
-
+   concepts/index.rst
 
 Troubleshooting
 ---------------
@@ -52,6 +52,25 @@ Troubleshooting
        :text-align: center
 
 
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+    :caption: Tutorials
+
+    tutorials/data_structures/index.rst
+    tutorials/language_and_usage/index.rst
+    tutorials/post_processing_basics/index.rst
+    tutorials/import_data/index.rst
+    tutorials/mesh/index.rst
+    tutorials/transform_data/index.rst
+    tutorials/export_data/index.rst
+    tutorials/plot/index.rst
+    tutorials/animate/index.rst
+    tutorials/enriching_dpf_capabilities/index.rst
+    tutorials/distributed_files/index.rst
+    tutorials/dpf_server/index.rst
+    tutorials/licensing/index.rst
+
 .. toctree::
    :maxdepth: 2
    :hidden:
@@ -61,30 +80,6 @@ Troubleshooting
    concepts/waysofusing.rst
    concepts/stepbystep.rst
 
-
-.. toctree::
-    :maxdepth: 2
-    :hidden:
-    :caption: DPF most-used entities
-
-    model
-    operators
-    fields_container
-
-
-.. toctree::
-    :maxdepth: 2
-    :hidden:
-    :caption: How-tos
-
-    plotting.rst
-    custom_operators.rst
-    dpf_server.rst
-    server_types.rst
-    server_context.rst
-    xmlfiles.rst
-
-
 .. toctree::
     :maxdepth: 3
     :hidden: