Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions .github/workflows/ci_cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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:
Expand Down
41 changes: 19 additions & 22 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

from datetime import datetime
import os
from pathlib import Path
import sys

sys.path.insert(0, os.path.abspath("../.."))
Expand All @@ -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,
Expand Down Expand Up @@ -59,6 +57,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 = {
Expand All @@ -73,12 +82,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
Expand Down Expand Up @@ -113,8 +122,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
Expand All @@ -139,23 +148,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
Expand Down Expand Up @@ -214,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
6 changes: 2 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
]
Expand Down
Loading