fix: Update the tox.ini to different tox env

.gitignore

@@ -101,3 +101,7 @@ doc/source/sg_execution_times.rst
 *prin-stresses.html
 doc/webserver.log
 doc/webserver.pid
+
+
+# Ignore any distributions directory to prevent accidental publications
+distributions/

doc/changelog.d/3164.fixed.md

@@ -0,0 +1 @@
+fix: Update the tox.ini to different tox env

doc/source/conf.py

@@ -96,10 +96,10 @@
     "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "sphinx_autodoc_typehints",
+    "sphinx_jinja",
     "sphinx_design",
     "sphinx_jinja",
     "sphinx_copybutton",
-    "sphinx_gallery.gen_gallery",
     "sphinxemoji.sphinxemoji",
     "sphinx.ext.graphviz",
     "ansys_sphinx_theme.extension.linkcode",
@@ -120,7 +120,7 @@
     "ansys-tools-path": ("https://path.tools.docs.pyansys.com/version/stable/", None),
 }
 
-suppress_warnings = ["label.*", "design.fa-build", "config.cache"]
+suppress_warnings = ["label.*", "design.fa-build", "config.cache", "design.grid"]
 sd_fontawesome_latex = True
 
 # Graphviz diagrams configuration
@@ -198,6 +198,49 @@
     "substitutions.rst",
 ]
 
+BUILD_API = True if os.environ.get("BUILD_API", "true") == "true" else False
+if not BUILD_API:
+    exclude_patterns.extend(["api/**", "mapdl_commands/**"])
+
+BUILD_EXAMPLES = True if os.environ.get("BUILD_EXAMPLES", "true") == "true" else False
+if not BUILD_EXAMPLES:
+    exclude_patterns.extend(["examples/index.rst", "examples/**", "examples/**/**"])
+    suppress_warnings.append("ref.*")
+else:
+    extensions.append("sphinx_gallery.gen_gallery")
+    # -- Sphinx Gallery Options ---------------------------------------------------
+    sphinx_gallery_conf = {
+        # convert rst to md for ipynb
+        "pypandoc": True,
+        # path to your examples scripts
+        "examples_dirs": [EXAMPLES_PATH_FOR_DOCS],
+        # path where to save gallery generated examples
+        "gallery_dirs": [GALLERY_EXAMPLES_PATH],
+        # Pattern to search for example files
+        "filename_pattern": r"\." + DEFAULT_EXAMPLE_EXTENSION,
+        # Remove the "Download all examples" button from the top level gallery
+        "download_all_examples": False,
+        # Sort gallery example by file name instead of number of lines (default)
+        "within_subsection_order": FileNameSortKey,
+        # directory where function granular galleries are stored
+        "backreferences_dir": None,
+        # Modules for which function level galleries are created.  In
+        "doc_module": "ansys-mapdl-core",
+        "image_scrapers": ("pyvista", "matplotlib"),
+        "ignore_pattern": "flycheck*",
+        "thumbnail_size": (350, 350),
+        "remove_config_comments": True,
+        "default_thumb_file": pyansys_light_mode_logo,
+        "show_signature": False,
+    }
+
+jinja_contexts = {
+    "main_toctree": {
+        "build_api": BUILD_API,
+        "build_examples": BUILD_EXAMPLES,
+    },
+}
+
 # make rst_epilog a variable, so you can add other epilog parts to it
 rst_epilog = ""
 
@@ -213,6 +256,7 @@
 with open("substitutions.rst") as f:
     rst_epilog += f.read()
 
+
 # Broken anchors:
 linkcheck_exclude_documents = ["index", "changelog"]
 linkcheck_anchors_ignore_for_url = ["https://docs.pyvista.org/api/*"]
@@ -252,34 +296,6 @@
 copybutton_prompt_text = r">>> ?|\.\.\. "
 copybutton_prompt_is_regexp = True
 
-# -- Sphinx Gallery Options ---------------------------------------------------
-sphinx_gallery_conf = {
-    # convert rst to md for ipynb
-    "pypandoc": True,
-    # path to your examples scripts
-    "examples_dirs": [EXAMPLES_PATH_FOR_DOCS],
-    # path where to save gallery generated examples
-    "gallery_dirs": [GALLERY_EXAMPLES_PATH],
-    # Pattern to search for example files
-    "filename_pattern": r"\." + DEFAULT_EXAMPLE_EXTENSION,
-    # Remove the "Download all examples" button from the top level gallery
-    "download_all_examples": False,
-    # Sort gallery example by file name instead of number of lines (default)
-    "within_subsection_order": FileNameSortKey,
-    # directory where function granular galleries are stored
-    "backreferences_dir": None,
-    # Modules for which function level galleries are created.  In
-    "doc_module": "ansys-mapdl-core",
-    "image_scrapers": ("pyvista", "matplotlib"),
-    "ignore_pattern": "flycheck*",
-    "thumbnail_size": (350, 350),
-    "remove_config_comments": True,
-    "default_thumb_file": pyansys_light_mode_logo,
-    "show_signature": False,
-}
-# ---
-
-
 # -- Options for HTML output -------------------------------------------------
 html_short_title = html_title = "PyMAPDL"
 html_theme = "ansys_sphinx_theme"

doc/source/getting_started/devcontainer.rst

@@ -67,7 +67,7 @@ Develop on a remote container
    The Docker image listed in the 
    `repository development container configuration files <pymapdl_devcontainer_configuration_>`_ 
    is not for public use due to licensing issues.
-   However, you can `create your own Docker image <ref_make_container_>`
+   However, you can `create your own Docker image <ref_make_container>`_
    and use this file as a template for setting your own local development container.
 
 To use a `remote container <vscode_devcontainers_containers_>`_, you must install this software:

doc/source/index.rst

@@ -5,18 +5,22 @@
    :keywords: pymapdl, mapdl, simulation, finite elements, python
    :description: Welcome to PyMAPDL documentation.
 
-
-.. toctree::
-   :hidden:
-   :maxdepth: 3
-
-   getting_started/index
-   user_guide/index
-   mapdl_commands/index
-   api/index
-   examples/index
-   changelog
-
+.. jinja:: main_toctree
+
+    .. toctree::
+       :hidden:
+       :maxdepth: 3
+
+       getting_started/index
+       user_guide/index
+       {% if build_api %}
+       mapdl_commands/index
+       api/index
+       {% endif %}
+       {% if build_examples %}
+       examples/index
+       {% endif %}
+       changelog
 
 .. image:: ../source/_static/logo_dark.png
     :class: only-dark
@@ -74,13 +78,17 @@
         Check our :ref:`ref_getting_started` section to learn to
         install MAPDL, install PyMAPDL or launch PyMAPDL.
 
-    .. grid-item-card:: :fa:`gears` See some PyMAPDL usage examples
-        :link: ref_examples
-        :link-type: ref
+    .. jinja:: main_toctree
+
+        {% if build_examples %}
+        .. grid-item-card:: :fa:`gears` See some PyMAPDL usage examples
+            :link: ref_examples
+            :link-type: ref
 
-        In our :ref:`ref_examples` section, you
-        can find a great collection of PyMAPDL
-        user cases.
+            In our :ref:`ref_examples` section, you
+            can find a great collection of PyMAPDL
+            user cases..
+        {% endif %}
 
     .. grid-item-card:: :fa:`book-open-reader` Use the different library modules
         :link: ref_user_guide