ansys / ansys/ansys-sphinx-theme

ansys_sphinx_theme.cheatsheet fails unregularly during ci

Open
#672 2 comments 0 reactions 1 assignee Claimed by @Revathyvenugopal162 View on GitHub
bug
Dominant language
Python
Stars
32
Forks
7
Avg merge
18h 20m
Merged PRs (30d)
36

Description

### 🔍 Before submitting the issue

- [x] I have searched among the existing issues
- [x] I am using a Python virtual environment

### 🐞 Description of the bug

We build our doc using ansys sphinx theme and it includes a CHeatsheet. sometime the pipeline fails with the following error:

Extension error (ansys_sphinx_theme.cheatsheet):

Handler for event 'builder-inited' threw an exception (exception: Failed to run the command: Command '['quarto', 'render', 'cheat_sheet_script.qmd', '--to', 'cheat_sheet-pdf', '--output-dir', PosixPath('/home/runner/work/pyspeos/pyspeos/doc/_build/html/_static'), '-V', 'version=v0.4.dev0']' returned non-zero exit status 1.)

make: *** [Makefile:38: html] Error 2

make: Leaving directory '/home/runner/work/pyspeos/pyspeos/doc'

### 📝 Steps to reproduce

got to pyspeos repo

run doc building action multiple times 1/25

### 💻 Which operating system are you using?

Linux

### 📀 Which ANSYS version are you using?

251

### 🐍 Which Python version are you using?

3.10

### 📦 Installed packages

```shell
it is a fresh setup from pyspeos using:
dependencies=[
"protobuf>=3.20,<6",
"grpcio>=1.50.0,<1.71",
"grpcio-health-checking>=1.45.0,<1.68",
"ansys-api-speos==0.14.2",
"numpy>=1.20.3,<3",
"comtypes>=1.4,<1.5",
]

doc = [
"ansys-sphinx-theme==1.4.2",
"numpydoc==1.8.0",
"Sphinx==8.1.3",
"sphinx-copybutton==0.5.2",
"sphinx-autoapi==3.6.0",
"sphinx_design==0.6.1",
"sphinx-jinja==2.0.2",
"sphinxcontrib-mermaid==1.0.0",
"myst-parser==4.0.1",
"nbsphinx==0.9.7",
"jupytext==1.16.7",
"jupyterlab==4.3.6",
"jupyter-server==2.15.0",
"nbconvert==7.16.6",
"pyvista[jupyter]>=0.43,<0.45",
"ansys-tools-visualization-interface>=0.8.3",
]
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.