Skip to content

Conversation

clatapie
Copy link
Contributor

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 graphics submodule.

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_commands branch. The latter will gather all the submodule changes, one by one, prior to be merged to the main branch.

Checklist

@clatapie clatapie self-assigned this Feb 18, 2025
@clatapie clatapie requested a review from a team as a code owner February 18, 2025 10:11
@clatapie clatapie requested review from germa89 and pyansys-ci-bot and removed request for a team February 18, 2025 10:11
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@github-actions github-actions bot added documentation Documentation related (improving, adding, etc) new feature Request or proposal for a new feature labels Feb 18, 2025
Copy link
Contributor

github-actions bot commented Mar 7, 2025

The towncrier template has been successfully rewritten with the default template.
Please ensure that sphinx-design is included as a dependency in your project's documentation requirements.
Additionally, add sphinx-design to the extensions list in your conf.py file.
For more information, please refer to the migration guide at:
https://actions.docs.ansys.com/version/stable/migrations/index.html#migration-guide

@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc dependencies maintenance General maintenance of the repo (libraries, cicd, etc) labels Mar 7, 2025
@github-actions github-actions bot removed CI/CD Related with CICD, Github Actions, etc dependencies maintenance General maintenance of the repo (libraries, cicd, etc) labels Mar 7, 2025
@RobPasMue
Copy link
Member

@clatapie - what's missing here? Can we have it merged?

@clatapie
Copy link
Contributor Author

This PR is also ready to merged if no additional changes are required.
Pinging @germa89 and @RobPasMue for visibility.

Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine by me -- letting it to @germa89 for the final call

Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few changes. One of the most important is the empty :math: commands.

Copy link
Contributor

@MaxJPRey MaxJPRey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the thorough review @germa89.
Great work @clatapie, I think this PR is close to a final state. Maybe some comments could be transformed in issue as soon as you merge your last commits and updates @germa89 's comments.

@clatapie
Copy link
Contributor Author

Pinging @germa89, @RobPasMue and @MaxJPRey for final review.
IMO, this PR is ready to be merged.

@clatapie clatapie requested a review from germa89 April 29, 2025 16:45
@germa89
Copy link
Collaborator

germa89 commented Apr 30, 2025

Looks good to me.

@clatapie @RobPasMue Shall we fix the Math equations (:math:) before merging more modules? Or do you prefer to go ahead with more modules?

@germa89 germa89 mentioned this pull request Apr 30, 2025
10 tasks
@RobPasMue
Copy link
Member

Looks good to me.

@clatapie @RobPasMue Shall we fix the Math equations (:math:) before merging more modules? Or do you prefer to go ahead with more modules?

I would move forward

@clatapie
Copy link
Contributor Author

I agree with @RobPasMue, math equations will be added in a future pyconverter-xml2py enhancement.

@clatapie clatapie merged commit 1167c3a into feat/main_commands Apr 30, 2025
43 checks passed
@clatapie clatapie deleted the feat/graphics_submodule branch April 30, 2025 09:09
@clatapie clatapie mentioned this pull request Jun 30, 2025
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related (improving, adding, 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