Skip to content

Conversation

clatapie
Copy link
Contributor

@clatapie clatapie commented Aug 6, 2025

Description

This PR follows the PyConverter-XML2Py integration plan to automate the PyMAPDL_commands documentation.
The changes have been generated using pyconverter-xml2py and more specifically mapdl-cmd-conv.

This PR focus on the first part of the solu submodule integration.

You can check the mapdl-cmd-conv documentation to have a look at the output of each methods.

Pinging @ansys/pymapdl-developers for visibility. Feel free to provide any feedback on the way the docstrings and the source code generation are handled.

Issue linked

This PR is meant to be merged within the feat/main_solu branch. The latter will gather all the parts of the submodule prior to be merged to the main branch.

Checklist

@clatapie clatapie self-assigned this Aug 6, 2025
@github-actions github-actions bot added documentation Documentation related (improving, adding, etc) new feature Request or proposal for a new feature labels Aug 6, 2025
@github-actions github-actions bot added dependencies maintenance General maintenance of the repo (libraries, cicd, etc) labels Aug 7, 2025
@clatapie clatapie marked this pull request as ready for review August 8, 2025 15:02
@clatapie clatapie requested a review from a team as a code owner August 8, 2025 15:02
@clatapie clatapie requested review from germa89 and pyansys-ci-bot and removed request for a team August 8, 2025 15:02
@github-actions github-actions bot removed dependencies maintenance General maintenance of the repo (libraries, cicd, etc) labels Aug 8, 2025
pyansys-ci-bot and others added 13 commits August 8, 2025 16:05
* fix: Moved scalar_param method to _MapdlCore class to access in MapdlInProcess

* ci: auto fixes from pre-commit.com hooks.

for more information, see https://pre-commit.ci

* chore: adding changelog file 4161.miscellaneous.md [dependabot-skip]

* chore: empty commit to trigger CICD

* fix: empty commit

---------

Co-authored-by: Valentin Allard <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: German <[email protected]>
Co-authored-by: Revathyvenugopal162 <[email protected]>
* Update CONTRIBUTORS.md with the latest contributors

* chore: adding changelog file 4169.miscellaneous.md [dependabot-skip]

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
…4171)

* ci: bump ansys/actions from 10.0.13 to 10.0.14 in the actions group

Bumps the actions group with 1 update: [ansys/actions](https://github.com/ansys/actions).


Updates `ansys/actions` from 10.0.13 to 10.0.14
- [Release notes](https://github.com/ansys/actions/releases)
- [Changelog](https://github.com/ansys/actions/blob/main/CHANGELOG.md)
- [Commits](ansys/actions@v10.0.13...v10.0.14)

---
updated-dependencies:
- dependency-name: ansys/actions
  dependency-version: 10.0.14
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: actions
...

Signed-off-by: dependabot[bot] <[email protected]>

* chore: adding changelog file 4171.miscellaneous.md [dependabot-skip]

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>
* ci: pre-commit autoupdate

updates:
- [github.com/shellcheck-py/shellcheck-py: v0.10.0.1 → v0.11.0.1](shellcheck-py/shellcheck-py@v0.10.0.1...v0.11.0.1)
- [github.com/pre-commit/pre-commit-hooks: v5.0.0 → v6.0.0](pre-commit/pre-commit-hooks@v5.0.0...v6.0.0)

* chore: adding changelog file 4170.miscellaneous.md [dependabot-skip]

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>
* feat: add deployment step for PR documentation in CI workflow

* feat: add PR documentation cleanup workflow for closed pull requests

* chore: adding changelog file 4173.miscellaneous.md [dependabot-skip]

* Update .github/workflows/ci.yml

* Update .github/workflows/ci.yml

* feat: add 'deploy pr docs' label and update CI workflow for PR documentation deployment

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
* feat: add automatic assignee assignment for pull requests

* fix: exclude specific bots from automatic assignee assignment in pull requests

* chore: adding changelog file 4174.miscellaneous.md [dependabot-skip]

* fix: update condition for adding assignee in pull requests to handle empty assignees correctly

* fix: update condition for checking empty assignees in pull requests

* chore: empty commit to trigger CICD and see not new assignments

* chore: adding changelog file 4174.miscellaneous.md [dependabot-skip]

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
* ci: pre-commit autoupdate

updates:
- [github.com/python-jsonschema/check-jsonschema: 0.33.2 → 0.33.3](python-jsonschema/check-jsonschema@0.33.2...0.33.3)

* chore: adding changelog file 4180.miscellaneous.md [dependabot-skip]

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>
…mmand (#4184)

* fix: reducing the amount of gRPC calls in get and add test for get command

* chore: adding changelog file 4184.miscellaneous.md [dependabot-skip]

* Update src/ansys/mapdl/core/mapdl_extended.py

Co-authored-by: Copilot <[email protected]>

* fix: improve test_get_not_muted by mocking wrinqr and asserting call

* fix: remove mute parameter from command execution in _MapdlCommandExtended

* fix: correct condition in force-output mode entry check

* fix: enhance test_get_not_muted to verify muted and unmuted states

* fix: correct assertion in test_get_not_muted to use 'mute' property

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Copilot <[email protected]>
* ci: bump the actions group with 2 updates

Bumps the actions group with 2 updates: [actions/download-artifact](https://github.com/actions/download-artifact) and [docker/login-action](https://github.com/docker/login-action).


Updates `actions/download-artifact` from 4.3.0 to 5.0.0
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](actions/download-artifact@d3f86a1...634f93c)

Updates `docker/login-action` from 3.4.0 to 3.5.0
- [Release notes](https://github.com/docker/login-action/releases)
- [Commits](docker/login-action@v3.4.0...v3.5.0)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-version: 5.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions
- dependency-name: docker/login-action
  dependency-version: 3.5.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: actions
...

Signed-off-by: dependabot[bot] <[email protected]>

* chore: adding changelog file 4183.miscellaneous.md [dependabot-skip]

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>
* chore: updating CHANGELOG for v0.71.0

* chore: adding changelog file 4192.miscellaneous.md [dependabot-skip]

* chore: reorg CHANGELOG for v0.71.0

---------

Co-authored-by: German <[email protected]>
* feat: enable use of conventional commits for PR title labeling

* fix: swap directory names for towncrier types 'Miscellaneous' and 'Documentation'

* chore: adding changelog file 4194.maintenance.md [dependabot-skip]

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
* chore: remove unused stale issue and release configuration files

* chore: adding changelog file 4195.miscellaneous.md [dependabot-skip]

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
germa89 and others added 9 commits August 26, 2025 17:16
* chore: remove Python UPF examples and related documentation

* chore: adding changelog file 4197.maintenance.md [dependabot-skip]

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
* ci: bump actions/checkout from 4 to 5 in the actions group

Bumps the actions group with 1 update: [actions/checkout](https://github.com/actions/checkout).


Updates `actions/checkout` from 4 to 5
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4...v5)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions
...

Signed-off-by: dependabot[bot] <[email protected]>

* chore: adding changelog file 4199.maintenance.md [dependabot-skip]

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>
* docs: update html_context with PyAnsys tags

* chore: adding changelog file 4202.documentation.md [dependabot-skip]

* ci: auto fixes from pre-commit.com hooks.

for more information, see https://pre-commit.ci

* chore: empty commit to trigger CICD2

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: German <[email protected]>
…member check (#4203)

* chore: update condition to include pre-commit-ci bot in organization member check

* chore: adding changelog file 4203.maintenance.md [dependabot-skip]

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
* feat: using screenshot method for plotting

* feat: adding plvar to plot commands

* chore: adding changelog file 4196.added.md [dependabot-skip]

* refactor: remove redundant reissuing of plot commands in _MapdlCore

* test: clean up screenshot file before test execution

* refactor: simplify screenshot filename filtering in MapdlGrpc class

* refactor: improve screenshot handling and filename management in _MapdlCore

* refactor: update screenshot filename handling in test cases

* test: update file handling in test_download_file_with_vkt_false

* refactor: remove unused plot command 'PLVA' from PLOT_COMMANDS so I can do another PR about it

* chore: adding changelog file 4196.miscellaneous.md [dependabot-skip]

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
* feat: using screenshot method for plotting

* feat: adding plvar to plot commands

* chore: adding changelog file 4196.added.md [dependabot-skip]

* refactor: remove redundant reissuing of plot commands in _MapdlCore

* test: clean up screenshot file before test execution

* refactor: simplify screenshot filename filtering in MapdlGrpc class

* refactor: improve screenshot handling and filename management in _MapdlCore

* refactor: update screenshot filename handling in test cases

* test: update file handling in test_download_file_with_vkt_false

* refactor: remove unused plot command 'PLVA' from PLOT_COMMANDS so I can do another PR about it

* feat: add plot command 'PLVA' to PLOT_COMMANDS

* feat: enhance PSD plotting functionality with MAPDL and matplotlib

* test: add test for plvar function to verify screenshot behavior

* chore: adding changelog file 4204.added.md [dependabot-skip]

* test: remove unused parameter from test_plvar function

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
* build: bump the documentation group with 2 updates

Bumps the documentation group with 2 updates: [pandas](https://github.com/pandas-dev/pandas) and [plotly](https://github.com/plotly/plotly.py).


Updates `pandas` from 2.3.1 to 2.3.2
- [Release notes](https://github.com/pandas-dev/pandas/releases)
- [Commits](pandas-dev/pandas@v2.3.1...v2.3.2)

Updates `plotly` from 6.2.0 to 6.3.0
- [Release notes](https://github.com/plotly/plotly.py/releases)
- [Changelog](https://github.com/plotly/plotly.py/blob/main/CHANGELOG.md)
- [Commits](plotly/plotly.py@v6.2.0...v6.3.0)

---
updated-dependencies:
- dependency-name: pandas
  dependency-version: 2.3.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: documentation
- dependency-name: plotly
  dependency-version: 6.3.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: documentation
...

Signed-off-by: dependabot[bot] <[email protected]>

* chore: adding changelog file 4205.dependencies.md [dependabot-skip]

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>
* fix: improve code quality and numpydoc documentation

- Fix typo in _get_file_name docstring parameter description
- Replace bare except clauses with specific OSError exceptions in launcher.py
- Remove duplicate logging statement in licensing.py, use LOG.info instead
- Add missing Parameters and Returns sections to Information class methods
- Fix GL02 docstring formatting issues (closing quotes placement)
- Add Returns section to convert.py format_using_autopep8 method

* fix: enable additional docstring checks for improved documentation quality

* Apply suggestions from code review

Co-authored-by: Copilot <[email protected]>

* chore: adding changelog file 4125.fixed.md [dependabot-skip]

* fix: enhance docstrings for MAPDL information properties to include return types

* fix: improve docstrings for GrpcError to include parameters and return types

* fix: update docstrings in convert.py to include parameters and return types

* fix: enhance docstrings in mapdl_extended.py to include parameters and return types

* chore: adding changelog file 4125.miscellaneous.md [dependabot-skip]

* fix: GL02 numpydoc issue

* fix: some PR01 issues.

* fix: enhance docstrings for return values in multiple classes

* fix: add test for title property in MapdlInfo class

* fix: all issues in information

---------

Co-authored-by: Copilot <[email protected]>
Co-authored-by: pyansys-ci-bot <[email protected]>
@ansys-cla-bot
Copy link

ansys-cla-bot bot commented Aug 29, 2025

All Contributor License Agreement (CLA) signatures have been captured successfully. Thanks for contributing!

@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc examples Publishing PyMAPDL examples dependencies maintenance General maintenance of the repo (libraries, cicd, etc) labels Aug 29, 2025
Copy link

codecov bot commented Aug 29, 2025

Codecov Report

❌ Patch coverage is 93.63057% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.24%. Comparing base (de1cf18) to head (cd9a61e).

Additional details and impacted files
@@                Coverage Diff                 @@
##           feat/main_solu    #4154      +/-   ##
==================================================
- Coverage           91.31%   91.24%   -0.07%     
==================================================
  Files                 193      198       +5     
  Lines               15724    15777      +53     
==================================================
+ Hits                14358    14396      +38     
- Misses               1366     1381      +15     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Related with CICD, Github Actions, etc dependencies documentation Documentation related (improving, adding, etc) examples Publishing PyMAPDL examples maintenance General maintenance of the repo (libraries, cicd, etc) new feature Request or proposal for a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants