From 51f23f2478e5b592fdbc70ae640e449e87582d55 Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Tue, 18 Nov 2025 07:25:53 +0100 Subject: [PATCH 01/13] docs: cleanup autoapi --- .github/workflows/ci_cd.yml | 26 ++++++++++++------------- doc/source/conf.py | 38 ++++++++++++++++++------------------- pyproject.toml | 6 ++---- 3 files changed, 33 insertions(+), 37 deletions(-) diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index c6e8c43f..58c0d3e9 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -107,8 +107,8 @@ jobs: - name: "Run Ansys documentation building action" uses: ansys/actions/doc-build@v8 with: - python-version: ${{ env.MAIN_PYTHON_VERSION }} - dependencies: "texlive-fonts-extra " + python-version: 3.13 + dependencies: "texlive-fonts-extra" package: name: "Package library" @@ -144,17 +144,17 @@ jobs: needs: [package] runs-on: ubuntu-latest steps: - - name: "Release to the public PyPI repository" - uses: ansys/actions/release-pypi-public@v8 - with: - library-name: ${{ env.PACKAGE_NAME }} - twine-username: "__token__" - twine-token: ${{ secrets.PYPI_TOKEN }} - - - name: "Release to GitHub" - uses: ansys/actions/release-github@v8 - with: - library-name: ${{ env.PACKAGE_NAME }} + - name: "Release to the public PyPI repository" + uses: ansys/actions/release-pypi-public@v8 + with: + library-name: ${{ env.PACKAGE_NAME }} + twine-username: "__token__" + twine-token: ${{ secrets.PYPI_TOKEN }} + + - name: "Release to GitHub" + uses: ansys/actions/release-github@v8 + with: + library-name: ${{ env.PACKAGE_NAME }} doc-deploy-stable: diff --git a/doc/source/conf.py b/doc/source/conf.py index 4c5988fd..c6412da0 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -11,7 +11,6 @@ ansys_favicon, ansys_logo_white, ansys_logo_white_cropped, - get_autoapi_templates_dir_relative_path, get_version_match, latex, pyansys_logo_black, @@ -59,6 +58,17 @@ "icon": "fa fa-comment fa-fw", }, ], + "ansys_sphinx_theme_autoapi": { + "project": project, + "ignore": ["*_visitors*"], + "options" : [ + "members", + "undoc-members", + "show-inheritance", + "show-module-summary", + "special-members", +] + }, } html_context = { @@ -73,12 +83,12 @@ extensions = [ "notfound.extension", # for the not found page. "numpydoc", - "autoapi.extension", "sphinx.ext.autosectionlabel", "sphinx.ext.coverage", "sphinx.ext.intersphinx", "sphinx_copybutton", "sphinx_design", + "ansys_sphinx_theme.extension.autoapi", ] # Intersphinx mapping @@ -113,8 +123,8 @@ "GL09", # Deprecation warning should precede extended summary "GL10", # reST directives {directives} must be followed by two colons "SS01", # No summary found - "SS02", # Summary does not start with a capital letter - "SS03", # Summary does not end with a period + # "SS02", # Summary does not start with a capital letter + # "SS03", # Summary does not end with a period "SS04", # Summary contains heading whitespaces "SS05", # Summary must start with infinitive verb, not third person "RT02", # The first line of the Returns section should contain only the @@ -139,23 +149,11 @@ master_doc = "index" # Configuration for Sphinx autoapi -autoapi_type = "python" -autoapi_dirs = ["../../src/ansys/"] -autoapi_root = "api" -autoapi_options = [ - "members", - "undoc-members", - "show-inheritance", - "show-module-summary", - "special-members", -] -autoapi_template_dir = get_autoapi_templates_dir_relative_path(Path(__file__)) suppress_warnings = ["autoapi.python_import_resolution"] -autoapi_python_use_implicit_namespaces = True -autoapi_render_in_single_page = ["class", "enum", "exception"] -autoapi_own_page_level = "class" -autoapi_ignore = ["*_visitors*"] -autoapi_keep_files = True +# autoapi_python_use_implicit_namespaces = True +# autoapi_render_in_single_page = ["class", "enum", "exception"] +# autoapi_own_page_level = "class" +# autoapi_keep_files = True # Generate section labels up to four levels deep autosectionlabel_maxdepth = 4 diff --git a/pyproject.toml b/pyproject.toml index c9d91e90..d2bf2892 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,15 +40,13 @@ dependencies = [ [project.optional-dependencies] doc=[ "ansys-engineeringworkflow-api==0.1.0", - "ansys-sphinx-theme==0.14.0", + "ansys-sphinx-theme[autoapi]==1.6.3", "numpydoc==1.6.0", "pyansys-tools-variableinterop==0.1.1", "pytest-sphinx==0.6.3", - "Sphinx==7.2.6", + "sphinx==8.2.3", "sphinx-copybutton==0.5.2", - "sphinx-design==0.6.1", "sphinx-copybutton==0.5.2", - "sphinx-autoapi==3.4.0", "sphinx-gallery==0.15.0", "sphinx-notfound-page==1.0.4", ] From 04e3477df0489e59f311ab9ce61d90bf53194406 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 18 Nov 2025 06:26:37 +0000 Subject: [PATCH 02/13] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- doc/source/conf.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index c6412da0..1a1a1056 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -61,13 +61,13 @@ "ansys_sphinx_theme_autoapi": { "project": project, "ignore": ["*_visitors*"], - "options" : [ - "members", - "undoc-members", - "show-inheritance", - "show-module-summary", - "special-members", -] + "options": [ + "members", + "undoc-members", + "show-inheritance", + "show-module-summary", + "special-members", + ], }, } From d219de2512a3eed8a1bfba1b11596c0495709ffa Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Tue, 18 Nov 2025 07:28:40 +0100 Subject: [PATCH 03/13] docs: precommit --- doc/source/conf.py | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index c6412da0..1b78e202 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -2,7 +2,6 @@ from datetime import datetime import os -from pathlib import Path import sys sys.path.insert(0, os.path.abspath("../..")) @@ -61,13 +60,13 @@ "ansys_sphinx_theme_autoapi": { "project": project, "ignore": ["*_visitors*"], - "options" : [ - "members", - "undoc-members", - "show-inheritance", - "show-module-summary", - "special-members", -] + "options": [ + "members", + "undoc-members", + "show-inheritance", + "show-module-summary", + "special-members", + ], }, } From a2982f19f7275807deb15cf39fb794883434301b Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Tue, 18 Nov 2025 14:58:16 +0100 Subject: [PATCH 04/13] fix: pdf build error --- doc/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 1b78e202..81b32d3f 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -211,4 +211,4 @@ # change the preamble of latex with customized title page # variables are the title of pdf, watermark latex_elements = {"preamble": latex.generate_preamble(html_title)} -sd_fontawesome_latex = True +# sd_fontawesome_latex = True From e9e28db941a81ae19f5fb6a0eb616e96d453c62d Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Fri, 21 Nov 2025 11:02:04 +0100 Subject: [PATCH 05/13] fix: python version --- .github/workflows/ci_cd.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index 0ebefd1f..24875eb2 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -114,7 +114,7 @@ jobs: - name: "Run Ansys documentation building action" uses: ansys/actions/doc-build@21c9de9bee9692173780696d4a39964f20b9cfa3 # v10.1.5 with: - python-version: ${{ env.MAIN_PYTHON_VERSION }} + python-version: "3.13" skip-install: true #dependencies: "texlive-fonts-extra" From c14da56b252dc413a22951b40ecfe57be8c69f9d Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Fri, 21 Nov 2025 11:04:34 +0100 Subject: [PATCH 06/13] fix: apt packages --- .github/workflows/ci_cd.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index 24875eb2..ff3346a9 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -104,19 +104,19 @@ jobs: runs-on: ubuntu-latest needs: [doc-style] steps: - - name: Temporary handle broken package dependencies - shell: bash - run: | - sudo apt-get update - sudo apt-get --fix-broken install -y - sudo apt-get install -y texlive-latex-extra latexmk texlive-fonts-extra + # - name: Temporary handle broken package dependencies + # shell: bash + # run: | + # sudo apt-get update + # sudo apt-get --fix-broken install -y + # sudo apt-get install -y texlive-latex-extra latexmk texlive-fonts-extra - name: "Run Ansys documentation building action" uses: ansys/actions/doc-build@21c9de9bee9692173780696d4a39964f20b9cfa3 # v10.1.5 with: python-version: "3.13" skip-install: true - #dependencies: "texlive-fonts-extra" + dependencies: "texlive-latex-extra latexmk texlive-fonts-extra" package: name: "Package library" From 8da34507f2da59875833f0b20f3967895b77da6d Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Fri, 21 Nov 2025 11:20:28 +0100 Subject: [PATCH 07/13] fix: apt packages --- doc/source/conf.py | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 81b32d3f..12f12c4c 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -148,11 +148,7 @@ master_doc = "index" # Configuration for Sphinx autoapi -suppress_warnings = ["autoapi.python_import_resolution"] -# autoapi_python_use_implicit_namespaces = True -# autoapi_render_in_single_page = ["class", "enum", "exception"] -# autoapi_own_page_level = "class" -# autoapi_keep_files = True +suppress_warnings = ["autoapi.python_import_resolution", "design.fa-build"] # Generate section labels up to four levels deep autosectionlabel_maxdepth = 4 From 0045af1a57b017196544e1438de700a46eb5fa54 Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Fri, 21 Nov 2025 11:22:37 +0100 Subject: [PATCH 08/13] fix: update dependencies --- pyproject.toml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 39f4d3bf..9720c8ae 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,14 +41,14 @@ dependencies = [ doc=[ "ansys-engineeringworkflow-api==0.1.0", "ansys-sphinx-theme[autoapi]==1.6.3", - "numpydoc==1.6.0", + "numpydoc==1.8.0", "pyansys-tools-variableinterop==0.1.1", "pytest-sphinx==0.6.3", "sphinx==8.2.3", "sphinx-copybutton==0.5.2", "sphinx-copybutton==0.5.2", - "sphinx-gallery==0.15.0", - "sphinx-notfound-page==1.0.4", + "sphinx-gallery==0.19.0", + "sphinx-notfound-page==1.1.0", ] tests = [ "ansys-engineeringworkflow-api==0.1.0", From 71ae7cac1f6d2b133ffd211e56ae74ab67ca5c6a Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Fri, 21 Nov 2025 11:27:17 +0100 Subject: [PATCH 09/13] fix: apt packages --- .github/workflows/ci_cd.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index ff3346a9..39078451 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -115,8 +115,8 @@ jobs: uses: ansys/actions/doc-build@21c9de9bee9692173780696d4a39964f20b9cfa3 # v10.1.5 with: python-version: "3.13" - skip-install: true - dependencies: "texlive-latex-extra latexmk texlive-fonts-extra" + # skip-install: true + # dependencies: "texlive-latex-extra latexmk texlive-fonts-extra" package: name: "Package library" From ba796fe45a35dd6e219de675e0252766c374fa89 Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Fri, 21 Nov 2025 12:08:24 +0100 Subject: [PATCH 10/13] fix: errors --- doc/source/conf.py | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 12f12c4c..87d93fd3 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -60,16 +60,17 @@ "ansys_sphinx_theme_autoapi": { "project": project, "ignore": ["*_visitors*"], - "options": [ - "members", - "undoc-members", - "show-inheritance", - "show-module-summary", - "special-members", - ], }, } +numpydoc_validation_exclude = { + "add_note", + "count", + "validate", + "__cause__", + "__context__", +} + html_context = { "display_github": True, # Integrate GitHub "github_user": USERNAME, @@ -122,8 +123,8 @@ "GL09", # Deprecation warning should precede extended summary "GL10", # reST directives {directives} must be followed by two colons "SS01", # No summary found - # "SS02", # Summary does not start with a capital letter - # "SS03", # Summary does not end with a period + "SS02", # Summary does not start with a capital letter + "SS03", # Summary does not end with a period "SS04", # Summary contains heading whitespaces "SS05", # Summary must start with infinitive verb, not third person "RT02", # The first line of the Returns section should contain only the From 4c61fabf729c86af897719d13736a8961cc910bd Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Fri, 21 Nov 2025 12:12:29 +0100 Subject: [PATCH 11/13] fix: python version --- .github/workflows/ci_cd.yml | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index 39078451..190f223f 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -16,7 +16,7 @@ concurrency: cancel-in-progress: true env: - MAIN_PYTHON_VERSION: '3.10' + MAIN_PYTHON_VERSION: '3.13' PACKAGE_NAME: 'ansys-modelcenter-workflow' PACKAGE_NAMESPACE: 'ansys.modelcenter.workflow' DOCUMENTATION_CNAME: 'modelcenter.docs.pyansys.com' @@ -104,19 +104,11 @@ jobs: runs-on: ubuntu-latest needs: [doc-style] steps: - # - name: Temporary handle broken package dependencies - # shell: bash - # run: | - # sudo apt-get update - # sudo apt-get --fix-broken install -y - # sudo apt-get install -y texlive-latex-extra latexmk texlive-fonts-extra - name: "Run Ansys documentation building action" uses: ansys/actions/doc-build@21c9de9bee9692173780696d4a39964f20b9cfa3 # v10.1.5 with: - python-version: "3.13" - # skip-install: true - # dependencies: "texlive-latex-extra latexmk texlive-fonts-extra" + python-version: ${{ env.MAIN_PYTHON_VERSION }} package: name: "Package library" From dcd03d34f91682944ee8febc72cef21ffccf8d32 Mon Sep 17 00:00:00 2001 From: Revathyvenugopal162 Date: Fri, 21 Nov 2025 13:55:51 +0100 Subject: [PATCH 12/13] fix: python version --- .github/workflows/ci_cd.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index 190f223f..b7d33dc9 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -16,7 +16,7 @@ concurrency: cancel-in-progress: true env: - MAIN_PYTHON_VERSION: '3.13' + MAIN_PYTHON_VERSION: '3.10' PACKAGE_NAME: 'ansys-modelcenter-workflow' PACKAGE_NAMESPACE: 'ansys.modelcenter.workflow' DOCUMENTATION_CNAME: 'modelcenter.docs.pyansys.com' @@ -108,7 +108,7 @@ jobs: - name: "Run Ansys documentation building action" uses: ansys/actions/doc-build@21c9de9bee9692173780696d4a39964f20b9cfa3 # v10.1.5 with: - python-version: ${{ env.MAIN_PYTHON_VERSION }} + python-version: 3.13 package: name: "Package library" From ecf61963853d63abe6f6fd4ca6105f4273e40980 Mon Sep 17 00:00:00 2001 From: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com> Date: Fri, 21 Nov 2025 16:47:51 +0100 Subject: [PATCH 13/13] Update pyproject.toml --- pyproject.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 9720c8ae..4b8a1901 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -46,7 +46,6 @@ doc=[ "pytest-sphinx==0.6.3", "sphinx==8.2.3", "sphinx-copybutton==0.5.2", - "sphinx-copybutton==0.5.2", "sphinx-gallery==0.19.0", "sphinx-notfound-page==1.1.0", ]