maint: update theme version, actions and logo (#501)

* fix: update logo and theme * fix: update actions version * chore: adding changelog file 501.fixed.md --------- Co-authored-by: pyansys-ci-bot <[email protected]>
ansys · Aug 19, 2024 · a4af9a0 · a4af9a0
1 parent f7203ba
commit a4af9a0
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 50 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,18 +1,18 @@
 repos:
 
 - repo: https://github.com/psf/black
-  rev: 23.3.0
+  rev: 24.8.0
   hooks:
   - id: black
     exclude: ^src/ansys/templates/python/
 
 - repo: https://github.com/pycqa/isort
-  rev: 5.12.0
+  rev: 5.13.2
   hooks:
   - id: isort
 
 - repo: https://github.com/PyCQA/flake8
-  rev: 6.0.0
+  rev: 7.1.1
   hooks:
   - id: flake8
     args: [
@@ -32,7 +32,7 @@ repos:
     exclude: ^src/ansys/templates/python/|^tests
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
+  rev: v4.6.0
   hooks:
   - id: check-merge-conflict
   - id: check-yaml
@@ -42,12 +42,12 @@ repos:
 
 # Validates github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.22.0
+  rev: 0.29.1
   hooks:
     - id: check-github-workflows
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.3.1
+  rev: v0.4.3
   hooks:
   - id: add-license-headers
     args:

diff --git a/doc/changelog.d/501.fixed.md b/doc/changelog.d/501.fixed.md
@@ -0,0 +1 @@
+maint: update theme version, actions and logo
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -25,7 +25,7 @@
 from datetime import datetime
 import os
 
-from ansys_sphinx_theme import ansys_favicon, ansys_logo_black, get_version_match
+from ansys_sphinx_theme import ansys_favicon, get_version_match
 
 from ansys.templates import __version__
 
@@ -38,7 +38,6 @@
 switcher_version = get_version_match(__version__)
 
 # use the default pyansys logo
-html_logo = ansys_logo_black
 html_favicon = ansys_favicon
 html_theme = "ansys_sphinx_theme"
 html_short_title = html_title = project  # necessary for proper breadcrumb title
@@ -58,7 +57,7 @@
         "json_url": f"https://{cname}/versions.json",
         "version_match": get_version_match(__version__),
     },
-    "check_switcher": False,
+    "logo": "ansys",
 }
 
 # Sphinx extensions

diff --git a/pyproject.toml b/pyproject.toml
@@ -42,7 +42,6 @@ maintainers = [
 classifiers = [
     "Development Status :: 4 - Beta",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
@@ -64,9 +63,9 @@ tests = [
     "pytest-cov==4.1.0",
 ]
 doc = [
-    "ansys-sphinx-theme==0.16.5",
-    "numpydoc==1.6.0",
-    "sphinx==7.3.7",
+    "ansys-sphinx-theme==1.0.5",
+    "numpydoc==1.8.0",
+    "Sphinx==8.0.2",
     "sphinx-copybutton==0.5.2",
 ]
 

diff --git a/.../templates/python/common/{{cookiecutter.__project_name_slug}}/.github/workflows/ci_cd.yml b/.../templates/python/common/{{cookiecutter.__project_name_slug}}/.github/workflows/ci_cd.yml
@@ -28,15 +28,15 @@ jobs:
       contents: write
       pull-requests: write
     steps:
-      - uses: ansys/actions/doc-deploy-changelog@v6
+      - uses: ansys/actions/doc-deploy-changelog@v7
         with:
           token: {{ '${{ secrets.PYANSYS_CI_BOT_TOKEN }}' }}
 
   code-style:
     name: "Code style"
     runs-on: ubuntu-latest
     steps:
-      - uses: ansys/actions/code-style@v6
+      - uses: ansys/actions/code-style@v7
         with:
           python-version: {{ '${{ env.MAIN_PYTHON_VERSION }}' }}
 
@@ -45,7 +45,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
-        uses: ansys/actions/doc-style@v6
+        uses: ansys/actions/doc-style@v7
         with:
           token: {{ '${{ secrets.GITHUB_TOKEN }}' }}
 
@@ -66,7 +66,7 @@ jobs:
         {%- endfor -%}
         python-version: {{ python_versions }}
     steps:
-      - uses: ansys/actions/build-wheelhouse@v6
+      - uses: ansys/actions/build-wheelhouse@v7
         with:
           library-name: {{ '${{ env.LIBRARY_NAME }}' }}
           operating-system: {{ '${{ matrix.os }}' }}
@@ -90,7 +90,7 @@ jobs:
       fail-fast: false
     steps:
       - name: PyAnsys tests check
-        uses: ansys/actions/tests-pytest@v6
+        uses: ansys/actions/tests-pytest@v7
         with:
           pytest-extra-args: "--cov=ansys --cov-report=term --cov-report=html:.cov/html"
           python-version: {{ '${{ matrix.python-version }}' }}
@@ -116,7 +116,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: [doc-style]
     steps:
-      - uses: ansys/actions/doc-build@v6
+      - uses: ansys/actions/doc-build@v7
         with:
           python-version: {{ '${{ env.MAIN_PYTHON_VERSION }}' }}
 
@@ -125,7 +125,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "Build library source and wheel artifacts"
-        uses: ansys/actions/build-library@v6
+        uses: ansys/actions/build-library@v7
         with:
           library-name: {{ '${{ env.LIBRARY_NAME }}' }}
 
@@ -135,7 +135,7 @@ jobs:
     needs: [doc-build, build-library]
     if: github.ref == 'refs/heads/main'
     steps:
-      - uses: ansys/actions/doc-deploy-dev@v6
+      - uses: ansys/actions/doc-deploy-dev@v7
         with:
           cname: {{ '${{ env.DOCUMENTATION_CNAME }}' }}
           token: {{ '${{ secrets.GITHUB_TOKEN }}' }}
@@ -146,7 +146,7 @@ jobs:
     needs: [doc-build, build-library]
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
     steps:
-      - uses: ansys/actions/doc-deploy-stable@v6
+      - uses: ansys/actions/doc-deploy-stable@v7
         with:
           cname: {{ '${{ env.DOCUMENTATION_CNAME }}' }}
           token: {{ '${{ secrets.GITHUB_TOKEN }}' }}
@@ -159,7 +159,7 @@ jobs:
   #   needs: doc-deploy-dev
   #   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 }}' }}/version/dev"
   #         index-name: "{{ '${{ env.LIBRARY_NAME }}'}}-vdev"
@@ -188,7 +188,7 @@ jobs:
   #         echo "VERSION_MEILI=$VERSION_MEILI" >> $GITHUB_ENV
 
   #     - 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 }}' }}/version/{{ '${{ env.VERSION }}' }}"
   #         index-name: "{{ '${{ env.LIBRARY_NAME }}' }}-v{{ '${{ env.VERSION_MEILI }}' }}"
@@ -203,7 +203,7 @@ jobs:
     steps:
       - name: "Release to the private PyPI repository"
         if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-        uses: ansys/actions/release-pypi-private@v6
+        uses: ansys/actions/release-pypi-private@v7
         with:
           library-name: {{ '${{ env.LIBRARY_NAME }}' }}
           twine-username: "__token__"
@@ -216,7 +216,7 @@ jobs:
   #   steps:
   #     - name: "Release to the public PyPI repository"
   #       if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-  #       uses: ansys/actions/release-pypi-public@v6
+  #       uses: ansys/actions/release-pypi-public@v7
   #       with:
   #         library-name: {{ '${{ env.DOCUMENTATION_CNAME }}' }}
   #         twine-username: "__token__"
@@ -229,6 +229,6 @@ jobs:
     steps:
       - name: "Release to GitHub"
         if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-        uses: ansys/actions/release-github@v6
+        uses: ansys/actions/release-github@v7
         with:
           library-name: {{ '${{ env.DOCUMENTATION_CNAME }}' }}
diff --git a/...nsys/templates/python/common/{{cookiecutter.__project_name_slug}}/.pre-commit-config.yaml b/...nsys/templates/python/common/{{cookiecutter.__project_name_slug}}/.pre-commit-config.yaml
@@ -1,7 +1,7 @@
 repos:
 
 - repo: https://github.com/psf/black
-  rev: 24.4.2
+  rev: 24.8.0
   hooks:
   - id: black
 
@@ -11,12 +11,12 @@ repos:
   - id: isort
 
 - repo: https://github.com/PyCQA/flake8
-  rev: 7.0.0
+  rev: 7.1.1
   hooks:
   - id: flake8
 
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.2.6
+  rev: v2.3.0
   hooks:
   - id: codespell
 
@@ -35,11 +35,11 @@ repos:
   - id: trailing-whitespace
 
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.28.2
+  rev: 0.29.1
   hooks:
     - id: check-github-workflows
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.3.1
+  rev: v0.4.3
   hooks:
   - id: add-license-headers
diff --git a/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/doc/source/conf.py b/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/doc/source/conf.py
@@ -4,15 +4,6 @@
 import os
 
 from ansys_sphinx_theme import get_version_match
-{%- if cookiecutter.__logo == "ansys" and cookiecutter.__logo_color == "white" %}
-from ansys_sphinx_theme import ansys_logo_white as logo
-{%- elif cookiecutter.__logo == "ansys" and cookiecutter.__logo_color == "black" %}
-from ansys_sphinx_theme import ansys_logo_black as logo
-{%- elif cookiecutter.__logo == "pyansys" and cookiecutter.__logo_color == "white" %}
-from ansys_sphinx_theme import pyansys_logo_white as logo
-{%- elif cookiecutter.__logo == "pyansys" and cookiecutter.__logo_color == "black" %}
-from ansys_sphinx_theme import pyansys_logo_black as logo
-{%- endif %}
 
 {%- if cookiecutter.__template_name != "doc-project" %}
 from {{cookiecutter.__pkg_namespace}} import __version__
@@ -36,7 +27,6 @@
 switcher_version = get_version_match(__version__)
 
 # Select desired logo, theme, and declare the html title
-html_logo = logo
 html_theme = "ansys_sphinx_theme"
 html_short_title = html_title = "{{ cookiecutter.__project_name_slug }}"
 
@@ -57,6 +47,11 @@
         "version_match": switcher_version,
     },
     "check_switcher": False,
+    {%- if cookiecutter.__logo == "pyansys" %}
+    "logo": "pyansys",
+    {%- elif cookiecutter.__logo == "ansys" %}
+    "logo": "ansys",
+    {%- endif %}
 }
 
 # Sphinx extensions

diff --git a/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/pyproject.toml b/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/pyproject.toml
@@ -36,17 +36,16 @@ dependencies = []
 
 [project.optional-dependencies]
 tests = [
-    "pytest==7.4.3",
+    "pytest==8.2.1",
     "pytest-cov==4.1.0",
 ]
 doc = [
-    "ansys-sphinx-theme==0.15.2",
-    "numpydoc==1.7.0",
-    "sphinx==7.3.7",
+    "ansys-sphinx-theme==1.0.5",
+    "numpydoc==1.8.0",
+    "Sphinx==8.0.2",
     "sphinx-copybutton==0.5.2",
 ]
 
-
 [tool.flit.module]
 name = "{{ cookiecutter.__pkg_namespace }}"
 

diff --git a/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/requirements_doc.txt b/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/requirements_doc.txt
@@ -1,4 +1,4 @@
-ansys-sphinx-theme==0.12.5
-numpydoc==1.6.0
-sphinx==7.2.6
+ansys-sphinx-theme==1.0.5
+numpydoc==1.8.0
+sphinx==8.0.2
 sphinx-copybutton==0.5.2