Generating documentation results in MAPDL error

[SRaimondi]

🔍 Before submitting the issue

• I have searched among the existing issues
• I am using a Python virtual environment

🐞 Description of the bug

In the documentation section, the step to generate the html documentation finishes with two reports of the same error ansys.mapdl.core.errors.PortAlreadyInUseByAnMAPDLInstance: The port The port 50052 is already used by an MAPDL instance. is already being used., coming from ..\..\examples\use_cases\01-optimizing-ply-angles.py and ..\..\examples\workflows\05-pymechanical-to-cdb-workflow.py. The full error traces can be seen here

The documentation is available at the end doc/build/html directory.

📝 Steps to reproduce

Follow the instructions from the README file, setting up PyACP for Development and try to build the documentation.

💻 Which operating system are you using?

Windows

📀 Which ANSYS version are you using?

2025 R1

🐍 Which Python version are you using?

3.10

📦 Installed packages

accessible-pygments==0.0.5
aiohappyeyeballs==2.4.4
aiohttp==3.11.9
aiosignal==1.3.1
alabaster==1.0.0
-e git+https://github.com/ansys/pyacp.git@c3d1dd3f38fc8721eaafd1b61c4c0f86250337cb#egg=ansys_acp_core
ansys-api-acp==0.2.0
ansys-api-mapdl==0.5.2
ansys-api-mechanical==0.1.2
ansys-api-platform-instancemanagement==1.1.0
ansys-api-tools-filetransfer==0.1.1
ansys-dpf-composites==0.6.1
ansys-dpf-core==0.13.3
ansys-mapdl-core==0.68.6
ansys-mapdl-reader==0.54.2
ansys-math-core==0.2.0
ansys-mechanical-core==0.11.10
ansys-mechanical-env==0.1.8
ansys-mechanical-stubs==0.1.4
ansys-platform-instancemanagement==1.1.2
ansys-pythonnet==3.1.0rc4
ansys-sphinx-theme==1.2.3
ansys-tools-filetransfer==0.1.1
ansys-tools-local-product-launcher==0.1.1
ansys-tools-path==0.7.0
ansys-tools-visualization-interface==0.6.0
anyio==4.6.2.post1
appdirs==1.4.4
argon2-cffi==23.1.0
argon2-cffi-bindings==21.2.0
arrow==1.3.0
asttokens==3.0.0
async-timeout==5.0.1
attrs==24.2.0
babel==2.16.0
beautifulsoup4==4.12.3
black==24.10.0
bleach==6.2.0
cachetools==5.5.0
certifi==2024.8.30
cffi==1.17.1
cfgv==3.4.0
charset-normalizer==3.4.0
click==8.1.7
clr-loader==0.2.6
colorama==0.4.6
comm==0.2.2
contourpy==1.3.1
coverage==7.6.8
cycler==0.12.1
debugpy==1.8.9
decopatch==1.4.10
decorator==5.1.1
defusedxml==0.7.1
distlib==0.3.9
docker==7.1.0
docutils==0.21.2
exceptiongroup==1.2.2
executing==2.1.0
fastjsonschema==2.21.0
filelock==3.16.1
fonttools==4.55.0
fqdn==1.5.1
frozenlist==1.5.0
geomdl==5.3.1
google-api-core==2.23.0
google-api-python-client==2.154.0
google-auth==2.36.0
google-auth-httplib2==0.2.0
googleapis-common-protos==1.66.0
grpcio==1.68.1
grpcio-health-checking==1.62.3
httplib2==0.22.0
hypothesis==6.122.3
identify==2.6.3
idna==3.10
imagesize==1.4.1
importlib_metadata==8.5.0
iniconfig==2.0.0
ipykernel==6.29.5
ipython==8.30.0
ipywidgets==8.1.5
isoduration==20.11.0
jedi==0.19.2
Jinja2==3.1.4
jsonpointer==3.0.0
jsonschema==4.23.0
jsonschema-specifications==2024.10.1
jupyter-events==0.10.0
jupyter_client==8.6.3
jupyter_core==5.7.2
jupyter_server==2.14.2
jupyter_server_proxy==4.4.0
jupyter_server_terminals==0.5.3
jupyterlab_pygments==0.3.0
jupyterlab_widgets==3.0.13
kiwisolver==1.4.7
makefun==1.15.6
MarkupSafe==3.0.2
matplotlib==3.9.3
matplotlib-inline==0.1.7
mistune==3.0.2
more-itertools==10.5.0
msgpack==1.1.0
multidict==6.1.0
mypy==1.13.0
mypy-extensions==1.0.0
nbclient==0.10.1
nbconvert==7.16.4
nbformat==5.10.4
nest-asyncio==1.6.0
networkx==3.4.2
nodeenv==1.9.1
numpy==2.2.0
numpydoc==1.8.0
overrides==7.7.0
packaging==24.2
pandocfilters==1.5.1
parso==0.8.4
pathspec==0.12.1
pdf2image==1.17.0
pillow==11.0.0
platformdirs==4.3.6
pluggy==1.5.0
pooch==1.8.2
pre_commit==4.0.1
prometheus_client==0.21.0
prompt_toolkit==3.0.48
propcache==0.2.1
proto-plus==1.25.0
protobuf==4.25.5
psutil==6.1.0
pure_eval==0.2.3
py-cpuinfo==9.0.0
pyansys-tools-versioning==0.6.0
pyasn1==0.6.1
pyasn1_modules==0.4.1
pycparser==2.22
pydata-sphinx-theme==0.16.0
Pygments==2.18.0
pyiges==0.3.1
pypandoc==1.14
pyparsing==3.2.0
pytest==8.3.4
pytest-benchmark==5.1.0
pytest-cases==3.8.6
pytest-cov==6.0.0
python-dateutil==2.9.0.post0
python-json-logger==2.0.7
pyvista==0.44.2
pywin32==308
pywinpty==2.0.14
PyYAML==6.0.2
pyzmq==26.2.0
referencing==0.35.1
requests==2.32.3
rfc3339-validator==0.1.4
rfc3986-validator==0.1.1
rpds-py==0.21.0
rsa==4.9
scipy==1.14.1
scooby==0.10.0
Send2Trash==1.8.3
simpervisor==1.0.0
six==1.16.0
sniffio==1.3.1
snowballstemmer==2.2.0
sortedcontainers==2.4.0
soupsieve==2.6
Sphinx==8.1.3
sphinx-copybutton==0.5.2
sphinx-gallery==0.18.0
sphinx-jinja==2.0.2
sphinx_design==0.6.1
sphinxcontrib-applehelp==2.0.0
sphinxcontrib-devhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==2.0.0
sphinxcontrib-serializinghtml==2.0.0
stack-data==0.6.3
tabulate==0.9.0
terminado==0.18.1
tinycss2==1.4.0
tomli==2.2.1
tornado==6.4.2
tqdm==4.67.1
traitlets==5.14.3
trame==3.7.0
trame-client==3.5.0
trame-server==3.2.3
trame-vtk==2.8.12
trame-vuetify==2.7.2
types-protobuf==5.29.1.20241207
types-python-dateutil==2.9.0.20241003
typing_extensions==4.12.2
uri-template==1.3.0
uritemplate==4.1.1
urllib3==2.2.3
virtualenv==20.28.0
vtk==9.3.1
wcwidth==0.2.13
webcolors==24.11.1
webencodings==0.5.1
websocket-client==1.8.0
websockets==14.1
widgetsnbextension==4.0.13
wslink==2.2.1
yarl==1.18.3
zipp==3.21.0

[greschd]

I've also encountered this error before, when building the documentation with a local MAPDL instance (i.e., not using the create_doc_windows.ps1 script). It seems to me the MAPDL instance is not properly shut down before a new one is started.

Note that this is not an issue when the examples are executed one-by-one, since the exiting Python process cleans up the MAPDL instance.

We can probably fix this by including the .exit() call explicitly in the examples.