maint: update tooling, cleanup and drop python 3.9 (#484)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: Revathyvenugopal162

.github/workflows/ci_cd.yml

@@ -97,7 +97,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12']
         should-release:
           - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
         exclude:

.pre-commit-config.yaml

@@ -1,30 +1,17 @@
 repos:
-- repo: https://github.com/psf/black
-  rev: 24.8.0
-  hooks:
-  - id: black
-
-- repo: https://github.com/pycqa/isort
-  rev: 5.13.2
-  hooks:
-  - id: isort
 
-- repo: https://github.com/PyCQA/flake8
-  rev: 7.1.1
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.6.2
   hooks:
-  - id: flake8
+    - id: ruff
+      args: [--fix]
+    - id: ruff-format
 
 - repo: https://github.com/codespell-project/codespell
   rev: v2.3.0
   hooks:
   - id: codespell
 
-- repo: https://github.com/pycqa/pydocstyle
-  rev: 6.3.0
-  hooks:
-  - id: pydocstyle
-    additional_dependencies: [toml]
-
 - repo: https://github.com/pre-commit/mirrors-prettier
   rev: 'v4.0.0-alpha.8'
   hooks:
@@ -41,18 +28,10 @@ repos:
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.29.1
+  rev: 0.29.2
   hooks:
     - id: check-github-workflows
 
-
-- repo: https://github.com/adamchainz/blacken-docs
-  rev: 1.18.0
-  hooks:
-  - id: blacken-docs
-    additional_dependencies: [black==24.4.2]
-    exclude: 'src/ansys_sphinx_theme/theme/ansys_sphinx_theme/_templates/'
-
 - repo: https://github.com/ansys/pre-commit-hooks
   rev: v0.4.3
   hooks:

README.rst

@@ -6,7 +6,7 @@ Ansys Sphinx theme
    :target: https://github.com/ansys
    :alt: Ansys
 
-.. |python| image:: https://img.shields.io/badge/Python-%3E%3D3.9-blue
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys_sphinx_theme?logo=pypi
    :target: https://pypi.org/project/ansys-sphinx-theme/
    :alt: Python
 
@@ -55,48 +55,25 @@ If you are new to using Sphinx, see `Sphinx Getting Started
 
 Documentation and issues
 ~~~~~~~~~~~~~~~~~~~~~~~~
-In addition to installation information, the
-`Ansys Sphinx theme documentation <https://sphinxdocs.ansys.com>`_
-provides information on how you can customize the theme. Because
-this documentation is created using this theme, viewing it is
-an easy way to preview the theme itself.
+Documentation for the latest stabe release of Ansys Sphinx theme is hosted at
+`Ansys Sphinx Theme documentation <https://sphinxdocs.ansys.com>`_.
+
+The documentation has these sections:
+
+- `Getting started <https://sphinxdocs.ansys.com/version/stable/getting_started.html>`_ : Learn
+  how to install the theme and use it in your Sphinx project.
+- `User guide <https://sphinxdocs.ansys.com/version/stable/user_guide.html>`_ : Learn how to
+  customize the theme and use its features.
+- `Examples <https://sphinxdocs.ansys.com/version/stable/examples.html>`_ : See examples of
+  Sphinx components and how it renders with the Ansys Sphinx theme.
+- `Release notes <https://sphinxdocs.ansys.com/version/stable/changelog.html>`_ : See the
+  changes in each release of the theme.
 
 On the `Issues page <https://github.com/ansys/ansys-sphinx-theme/issues>`_
 for this repository, you can create issues to submit questions, report bugs,
 and request new features. To reach the PyAnsys support team, email
 `[email protected] <[email protected]>`_.
 
-Getting started
-~~~~~~~~~~~~~~~
-Install the ``ansys-sphinx-theme`` package with:
-
-.. code::
-
-   python -m pip install ansys-sphinx-theme
-
-Modify your Sphinx ``conf.py`` file to use ``html_theme =
-'ansys_sphinx_theme'``.
-
-Development and contributions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you want to contribute to the PyAnsys Sphinx theme, install
-the ``ansys-sphinx-theme`` package in development mode with::
-
-   git clone https://github.com/ansys/ansys-sphinx-theme.git
-   python -m pip install -U pip tox
-   tox -e style,doc
-
-To simplify checks, this repository uses `pre-commit <https://pre-commit.com/>`_.
-You can optionally install and use this tool. For more information, see its
-`installation <https://pre-commit.com/#install>`_ and `usage
-<https://pre-commit.com/#usage>`_ documentation.
-
-Before contributing to a PyAnsys library, see
-`Contributing <https://dev.docs.pyansys.com//how-to/contributing.html>`_
-in the *PyAnsys Developer's Guide* for overall guidance, paying particular
-attention to `How-to <https://dev.docs.pyansys.com//how-to/index.html>`_ for
-guidelines and best practices.
-
 License
 ~~~~~~~
 This theme is licensed under the `MIT License

doc/changelog.d/484.fixed.md

@@ -0,0 +1 @@
+maint: update tooling, cleanup and drop python 3.9

doc/source/conf.py

@@ -146,7 +146,7 @@
     "examples/gallery-examples/*.ipynb",
 ]
 rst_epilog = ""
-with open("links.rst") as f:
+with Path.open(THIS_PATH / "links.rst", "r") as f:
     rst_epilog += f.read()
 
 sphinx_gallery_conf = {
@@ -234,7 +234,7 @@ def download_and_process_files(example_links: List[str]) -> List[str]:
     for link in example_links:
         file_name = link.split("/")[-1]
         file_path = str((EXAMPLE_PATH / file_name).absolute())
-        with open(file_path, "wb") as f:
+        with open(file_path, "wb") as f:  # noqa: PTH123
             response = requests.get(link)
             content = response.content.decode()
             lines = content.splitlines()

doc/source/examples/nbsphinx/jupyter-notebook.ipynb

@@ -23,7 +23,7 @@
    "source": [
     "import pyvista as pv\n",
     "\n",
-    "pv.set_jupyter_backend('html')\n",
+    "pv.set_jupyter_backend(\"html\")\n",
     "\n",
     "sphere = pv.Sphere()\n",
     "sphere.plot()"
@@ -36,8 +36,8 @@
    "outputs": [],
    "source": [
     "plotter = pv.Plotter(notebook=True)\n",
-    "plotter.add_mesh(sphere, color='white', show_edges=True)\n",
-    "plotter.title = '3D Sphere Visualization'\n",
+    "plotter.add_mesh(sphere, color=\"white\", show_edges=True)\n",
+    "plotter.title = \"3D Sphere Visualization\"\n",
     "plotter.show()"
    ]
   },
@@ -55,7 +55,8 @@
    "outputs": [],
    "source": [
     "from IPython.display import Math\n",
-    "eq = Math(r'\\int\\limits_{-\\infty}^\\infty f(x) \\delta(x - x_0) dx = f(x_0)')\n",
+    "\n",
+    "eq = Math(r\"\\int\\limits_{-\\infty}^\\infty f(x) \\delta(x - x_0) dx = f(x_0)\")\n",
     "eq"
    ]
   },
@@ -66,7 +67,8 @@
    "outputs": [],
    "source": [
     "from IPython.display import Latex\n",
-    "Latex(r'This is a \\LaTeX{} equation: $a^2 + b^2 = c^2$')"
+    "\n",
+    "Latex(r\"This is a \\LaTeX{} equation: $a^2 + b^2 = c^2$\")"
    ]
   },
   {
@@ -107,9 +109,9 @@
     "\n",
     "# Create a dictionary of data\n",
     "data = {\n",
-    "    'A': [True, False, True, False],\n",
-    "    'B': [False, True, False, True],\n",
-    "    'C': [True, True, False, False],\n",
+    "    \"A\": [True, False, True, False],\n",
+    "    \"B\": [False, True, False, True],\n",
+    "    \"C\": [True, True, False, False],\n",
     "}\n",
     "\n",
     "# Create DataFrame from the dictionary\n",

doc/source/examples/snippet.py

@@ -48,7 +48,7 @@ def func(arg1, arg2):
 
     Examples
     --------
-    >>> func(1, 'foo')
+    >>> func(1, "foo")
     True
 
     """

pyproject.toml

@@ -8,7 +8,7 @@ name = "ansys-sphinx-theme"
 version = "1.1.dev0"
 description = "A theme devised by ANSYS, Inc. for Sphinx documentation."
 readme = "README.rst"
-requires-python = ">=3.9,<4"
+requires-python = ">=3.10,<4"
 license = {file = "LICENSE"}
 authors = [{ name = "ANSYS, Inc.", email = "[email protected]" }]
 maintainers = [{ name = "ANSYS, Inc.", email = "[email protected]" }]
@@ -18,7 +18,9 @@ classifiers = [
     "Framework :: Sphinx :: Theme",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
     "Sphinx>=4.2.0",
@@ -74,14 +76,39 @@ Source = "https://github.com/ansys/ansys-sphinx-theme"
 Tracker = "https://github.com/ansys/ansys-sphinx-theme/issues"
 Documentation = "https://sphinxdocs.ansys.com/"
 
-[tool.black]
+[tool.ruff]
 line-length = 100
+fix = true
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.ruff.lint]
+select = [
+    "E",    # pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+    "D",    # pydocstyle, see https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    "F",    # pyflakes, see https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "I",    # isort, see https://docs.astral.sh/ruff/rules/#isort-i
+    "N",    # pep8-naming, see https://docs.astral.sh/ruff/rules/#pep8-naming-n
+    "PTH",  # flake8-use-pathlib, https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+    "TD",   # flake8-todos, https://docs.astral.sh/ruff/rules/#flake8-todos-td
+]
+ignore = [
+    "TD002", # Missing author in TODOs comment
+]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+"doc/source/examples/sphinx-gallery/sphinx-gallery.py" = ["D205", "E402", "D400"]
+"src/ansys_sphinx_theme/extension/linkcode.py" = ["E501"]
 
-[tool.isort]
-profile = "black"
-force_sort_within_sections = true
-line_length = 100
-src_paths = ["doc", "src"]
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+force-sort-within-sections = true
 
 [tool.coverage.run]
 source = ["src"]
@@ -122,8 +149,6 @@ directory = "miscellaneous"
 name = "Miscellaneous"
 showcontent = true
 
-
-
 [[tool.towncrier.type]]
 directory = "documentation"
 name = "Documentation"

src/ansys_sphinx_theme/__init__.py

@@ -20,7 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-"""This is the ansys-sphinx-theme module."""
+"""Module for the Ansys Sphinx theme."""
+
 import logging
 import os
 import pathlib
@@ -341,9 +342,9 @@ def replace_html_tag(app, exception):
 
     file_names = list(api_path.rglob("*.html"))
     for file_name in file_names:
-        with open(api_dir / file_name, "r", encoding="utf-8") as file:
+        with pathlib.Path.open(api_dir / file_name, "r", encoding="utf-8") as file:
             content = file.read()
-        with open(api_dir / file_name, "w", encoding="utf-8") as file:
+        with pathlib.Path.open(api_dir / file_name, "w", encoding="utf-8") as file:
             modified_content = content.replace("&lt;", "<").replace("&gt;", ">")
             file.write(modified_content)
 
@@ -472,7 +473,7 @@ def build_quarto_cheatsheet(app: Sphinx):
     output_dir_path = pathlib.Path(app.outdir) / output_dir
     try:
         # Add the cheatsheet to the Quarto project
-        result = subprocess.run(
+        subprocess.run(
             [
                 "quarto",
                 "add",
@@ -485,7 +486,7 @@ def build_quarto_cheatsheet(app: Sphinx):
         )
 
         # Render the cheatsheet
-        render_result = subprocess.run(
+        subprocess.run(
             [
                 "quarto",
                 "render",
@@ -501,7 +502,7 @@ def build_quarto_cheatsheet(app: Sphinx):
         )
 
         # Remove the cheatsheet from the Quarto project
-        remove_extension = subprocess.run(
+        subprocess.run(
             ["quarto", "remove", "ansys/cheat_sheet", "--no-prompt"],
             cwd=file_path,
             capture_output=True,

src/ansys_sphinx_theme/examples/sample_func.py

@@ -48,7 +48,7 @@ def func(arg1, arg2):
 
     Examples
     --------
-    >>> func(1, 'foo')
+    >>> func(1, "foo")
     True
 
     """