Bump sphinx from 7.1.0 to 8.1.3 in /requirements (#1922)

* Bump sphinx from 7.1.0 to 8.1.3 in /requirements

Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 7.1.0 to 8.1.3.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/v8.1.3/CHANGES.rst)
- [Commits](sphinx-doc/sphinx@v7.1.0...v8.1.3)

---
updated-dependencies:
- dependency-name: sphinx
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* ci: add tox.ini file

* fix: tox.ini syntax and gitignore

* fix: ignoring failing files results in successful doc build.

* docs: added some hooks for troubleshooting the issue

* fix: updated server and process closing logic after sphinx-gallery execution

* fix: modified function checking server closure after sphinx gallery execution

* fix: added ipykernel to address 'No python3 ...' error

* fix: build issues

* Update requirements/requirements_docs.txt

* fix: activate failing example

* fix: remove reset servers logic

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Jorge Martínez <[email protected]>
Co-authored-by: Jorge Martinez Garrido <[email protected]>
Co-authored-by: moe-ad <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>
Co-authored-by: Muhammed Adedigba <[email protected]>

Author: 5 people

.gitignore

@@ -192,3 +192,8 @@ src/ansys/grpc/
 
 # C extensions
 *.so
+
+# Ignore auto-generated API reference
+doc/source/api
+doc/source/examples
+doc/source/images/auto-generated

doc/source/conf.py

@@ -1,13 +1,18 @@
-import os
-import sys
-from glob import glob
 from datetime import datetime
+from glob import glob
+import os
 
+from ansys_sphinx_theme import (
+    ansys_favicon,
+    get_version_match,
+    pyansys_logo_dark_mode,
+    pyansys_logo_light_mode,
+)
 import numpy as np
 import pyvista
+
 from ansys.dpf.core import __version__, server, server_factory
 from ansys.dpf.core.examples import get_example_required_minimum_dpf_version
-from ansys_sphinx_theme import ansys_favicon, get_version_match, pyansys_logo_light_mode, pyansys_logo_dark_mode
 
 # Manage errors
 pyvista.set_error_output_file("errors.txt")
@@ -161,9 +166,11 @@
 
 
 def reset_servers(gallery_conf, fname, when):
+    import gc
+
     import psutil
+
     from ansys.dpf.core import server
-    import gc
 
     gc.collect()
     server.shutdown_all_session_servers()
@@ -174,7 +181,7 @@ def reset_servers(gallery_conf, fname, when):
         try:
             # check whether the process name matches
             if proc_name in proc.name():
-                # proc.kill()
+                proc.kill()
                 nb_procs += 1
         except psutil.NoSuchProcess:
             pass
@@ -259,7 +266,7 @@ def reset_servers(gallery_conf, fname, when):
 
 # Configuration for Sphinx autoapi
 suppress_warnings = [
-    "autoapi.python_import_resolution", # Todo: remove suppression of this warning in the future
+    "autoapi.python_import_resolution", # TODO: remove suppression of this warning in the future #1967
     "design.grid",
     "config.cache",
     "design.fa-build",
@@ -366,4 +373,4 @@ def reset_servers(gallery_conf, fname, when):
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ["search.html"]
+epub_exclude_files = ["search.html"]

requirements/requirements_docs.txt

@@ -7,7 +7,7 @@ nbsphinx==0.9.6
 pypandoc==1.15
 pytest-sphinx==0.6.3
 pyvista==0.44.2
-sphinx==7.4.7
+sphinx==8.1.3
 sphinx-copybutton==0.5.2
 sphinx-gallery==0.19.0
 sphinx-notfound-page==1.1.0