diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index e1aa4289..b7d33dc9 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -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: ${{ env.MAIN_PYTHON_VERSION }} - skip-install: true - #dependencies: "texlive-fonts-extra" + python-version: 3.13 package: name: "Package library" @@ -152,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 af4b98f0..eec64cdb 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("../..")) @@ -11,7 +10,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 +57,18 @@ "icon": "fa fa-comment fa-fw", }, ], + "ansys_sphinx_theme_autoapi": { + "project": project, + "ignore": ["*_visitors*"], + }, +} + +numpydoc_validation_exclude = { + "add_note", + "count", + "validate", + "__cause__", + "__context__", } html_context = { @@ -74,12 +84,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 @@ -140,23 +150,7 @@ master_doc = "index" # Configuration for Sphinx autoapi -autoapi_type = "python" -autoapi_dirs = ["../../src/ansys/modelcenter/workflow"] -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", "design.fa-build"] -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 # Generate section labels up to four levels deep autosectionlabel_maxdepth = 4 diff --git a/pyproject.toml b/pyproject.toml index d11f8b66..4b8a1901 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,14 +40,12 @@ dependencies = [ [project.optional-dependencies] doc=[ "ansys-engineeringworkflow-api==0.1.0", - "ansys-sphinx-theme==1.6.3", + "ansys-sphinx-theme[autoapi]==1.6.3", "numpydoc==1.8.0", "pyansys-tools-variableinterop==0.1.1", "pytest-sphinx==0.6.3", - "Sphinx==8.1.3", + "sphinx==8.2.3", "sphinx-copybutton==0.5.2", - "sphinx-design==0.6.1", - "sphinx-autoapi==3.6.1", "sphinx-gallery==0.19.0", "sphinx-notfound-page==1.1.0", ]