Merge branch 'main' into dependabot/github_actions/actions/upload-artifact-4.3.6

Author: RobPasMue

.github/workflows/ci_cd.yml

@@ -29,7 +29,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "Check documentation style"
-        uses: ansys/actions/doc-style@v6
+        uses: ansys/actions/doc-style@v7
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -47,7 +47,7 @@ jobs:
           sudo apt-get install graphviz
 
       - name: "Build project documentation"
-        uses: ansys/actions/doc-build@v6
+        uses: ansys/actions/doc-build@v7
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           use-python-cache: false
@@ -83,7 +83,7 @@ jobs:
     needs: doc-deploy
     steps:
       - name: "Deploy the latest documentation index"
-        uses: ansys/actions/doc-deploy-index@v6
+        uses: ansys/actions/doc-deploy-index@v7
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           index-name: "pyansys-dev-guide"

doc/source/conf.py

@@ -21,7 +21,6 @@
 author = "Ansys Inc."
 release = version = datetime.now().strftime("%Y-%m-%d")
 
-html_logo = pyansys_logo_black
 html_theme = "ansys_sphinx_theme"
 html_favicon = ansys_favicon
 html_context = {
@@ -32,6 +31,7 @@
 }
 
 html_theme_options = {
+    "logo": "pyansys",
     "github_url": "https://github.com/ansys/dev-guide",
     "show_prev_next": False,
     "show_breadcrumbs": True,
@@ -86,7 +86,7 @@
     # Remove sphinx configuration comments from code blocks
     "remove_config_comments": True,
     # Sort gallery example by file name instead of number of lines (default)
-    "within_subsection_order": FileNameSortKey,
+    "within_subsection_order": "FileNameSortKey",
     # directory where function granular galleries are stored
     "backreferences_dir": None,
     # Modules for which function level galleries are created.  In

doc/source/content-writing/content-contrib-setup/content-dev-environment.rst

@@ -381,5 +381,5 @@ to contributing to PyAnsys documentation, see :ref:`resources_writers`.
    You can customize the Ansys Sphinx Theme by making changes to the
    ``html_theme_options`` dictionary in the Sphinx configuration (``conf.py``)
    file in the ``doc`` directory. For additional information, see
-   `HTML theme options <https://sphinxdocs.ansys.com/version/stable/user_guide/options.html>`_
+   `HTML theme options <https://sphinxdocs.ansys.com/version/stable/user-guide/options.html>`_
    in the Ansys Sphinx Theme documentation.

doc/source/content-writing/content-how-tos/show_cheat_sheet_thumbnail.rst

@@ -12,5 +12,5 @@ shows a cheat sheet thumbnail on the landing page of the PyMechanical documentat
 
 To show a thumbnail, you add a child ``cheatsheet`` dictionary to the Sphinx
 configuration (``conf.py``) file in the ``doc`` directory as described in
-`Cheat Sheets <https://sphinxdocs.ansys.com/version/stable/user_guide/options.html#cheat-sheets>`_
+`Cheat Sheets <https://sphinxdocs.ansys.com/version/stable/user-guide/options.html#cheat-sheets>`_
 in the Ansys Sphinx Theme documentation.

requirements/requirements_doc.txt

@@ -1,9 +1,9 @@
-Sphinx==7.2.6
-ansys-sphinx-theme==0.16.6
+Sphinx==8.0.2
+ansys-sphinx-theme==1.0.3
 sphinx-copybutton==0.5.2
 sphinx_toolbox==3.7.0
 sphinx_design==0.6.1
 sphinxcontrib-mermaid>=0.7.1
-sphinx-gallery==0.17.0
+sphinx-gallery==0.17.1
 Pillow>=9.0
 pyvista==0.44.1