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

@@ -113,6 +113,8 @@
     "sphinx_design",
     "sphinx_jinja",
     'sphinx_reredirects',
+    "ansys_sphinx_theme.extension.autoapi",
+    "jupyter_sphinx",
 ]
 
 redirects = {
@@ -156,7 +158,14 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = ["links_and_refs.rst"]
+
+# make rst_epilog a variable, so you can add other epilog parts to it
+rst_epilog = ""
+
+# Read links and targets from file
+with open("links_and_refs.rst") as f:
+    rst_epilog += f.read()
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
@@ -376,6 +385,20 @@ 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))
+
 # Common content for every RST file such us links
 rst_epilog = ""
 links_filepath = Path(__file__).parent.absolute() / "links.rst"
@@ -404,4 +427,4 @@ def reset_servers(gallery_conf, fname, when):
 
 BUILD_EXAMPLES = True if os.environ.get("BUILD_EXAMPLES", "true") == "true" else False
 if BUILD_EXAMPLES:
-    extensions.extend(["sphinx_gallery.gen_gallery"])
+    extensions.extend(["sphinx_gallery.gen_gallery"])

doc/source/getting_started/contributing.rst

@@ -3,10 +3,17 @@
 Contributing
 ############
 
+There are several ways to contribute to PyDPF-Core:
+
+- :ref:`ref_contributing_answer_discussions`
+- :ref:`ref_contributing_post_issues`
+- :ref:`ref_contributing_develop_code`
+- :ref:`ref_contributing_improve_doc`
+
 Overall guidance on contributing to a PyAnsys repository appears in
-`Contribute <https://dev.docs.pyansys.com/how-to/contributing.html>`_
-in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
-with this guide before attempting to contribute to PyDPF-Core.
+`Contributing <dev_guide_contributing_>`_ in the *PyAnsys Developer's Guide*.
+Ensure that you are thoroughly familiar with this guide before attempting
+to contribute to PyDPF-Core.
 
 .. important::
 

doc/source/getting_started/install.rst

@@ -7,7 +7,7 @@ Installation
 Install using ``pip``
 ---------------------
 
-The standard package installer for Python is `pip <https://pypi.org/project/pip/>`_.
+The standard package installer for Python is `pip <pip_pypi_page_>`_.
 
 To use PyDPF-Core with Ansys 2022 R2 or later, install the latest version
 with this command:
@@ -16,7 +16,7 @@ with this command:
 
    pip install ansys-dpf-core
 
-PyDPF-Core plotting capabilities require you to have `PyVista <https://pyvista.org/>`_ installed.
+PyDPF-Core plotting capabilities require you to have `PyVista <pyvista_org_>`_ installed.
 To install PyDPF-Core with its optional plotting functionalities, run this command:
 
 .. code::
@@ -58,7 +58,7 @@ Install without internet
 
 If you are unable to install PyDPF-Core on the host machine using ``pip`` due to
 network isolation, download the wheelhouse corresponding to your platform and Python interpreter version
-for the latest release of PyDPF-Core from the assets section of the `latest PyDPF-Core release on GitHub <https://github.com/ansys/pydpf-core/releases/latest>`_.
+for the latest release of PyDPF-Core from the assets section of the `latest PyDPF-Core release on GitHub <pydpfcore_latest_release>`_.
 
 The wheelhouse is a ZIP file containing Python wheels for all the packages PyDPF-Core requires to run.
 To install PyDPF-Core using the downloaded wheelhouse, unzip the wheelhouse to a local directory,
@@ -70,8 +70,8 @@ then use the following command from within this local directory:
 
 Note that PyDPF-Core wheelhouses do not include the optional plotting dependencies.
 To use the plotting capabilities, also download the wheels corresponding to your platform and Python interpreter version
-for `PyVista <https://pypi.org/project/pyvista/#files>`_ and 
-`matplotlib <https://pypi.org/project/matplotlib/#files>`_. Then, place them in the same local directory and run the preceding command.
+for `PyVista <pyvista_download_files_>`_ and 
+`matplotlib <matplotlib_download_files_>`_. Then, place them in the same local directory and run the preceding command.
 
 
 Install in development mode

doc/source/getting_started/write_code/index.rst

@@ -0,0 +1,61 @@
+.. _ref_write_code:
+
+============
+Develop code
+============
+
+You can help improve PyDPF-Core by fixing a bug. To do it, you must set up the repository
+on your local machine as per the following steps:
+
+- :ref:`ref_write_code_install`
+- :ref:`ref_write_code_clone`
+- :ref:`ref_write_code_check_install`
+- :ref:`ref_write_code_develop_code`
+
+.. _ref_write_code_install:
+
+Install the repository and the DPF server
+-----------------------------------------
+
+Install the PyDPF-Core repository by following the steps in :ref:`installation` and :ref:`ref_dpf_server`.
+
+.. _ref_write_code_clone:
+
+Clone the repository
+--------------------
+
+Before cloning the PyDPF-Core repository, you must install a version control system such as Git.
+
+Then, clone the latest version of PyDPF-Core in development mode (using ``pip`` with the ``-e``
+development flag) by running this code:
+
+.. code::
+
+    git clone https://github.com/ansys/pydpf-core
+    cd pydpf-core
+    pip install -e .
+
+.. _ref_write_code_check_install:
+
+Check the installation
+----------------------
+
+Run the following Python code to verify your PyDPF-Core installation:
+
+.. code::
+
+   from ansys.dpf.core import Model
+   from ansys.dpf.core import examples
+   model = Model(examples.find_simple_bar())
+   print(model)
+
+.. _ref_write_code_develop_code:
+
+Develop the PyDPF-Core code
+---------------------------
+
+Overall guidance on contributing to the code of a PyAnsys repository appears in
+`Contributing <dev_guide_contributing_>`_ in the *PyAnsys Developer's Guide*.
+
+You must also follow the `Coding style <dev_guide_coding_style_>`_ guide to ensure
+that all source code looks the same across the project.