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 database 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 17, 2025
@clatapie clatapie requested a review from a team as a code owner February 17, 2025 17:28
@clatapie clatapie requested review from germa89 and pyansys-ci-bot and removed request for a team February 17, 2025 17:28
@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 17, 2025
@clatapie clatapie changed the title feat: adding database submodule feat: database submodule Feb 17, 2025
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.

Good work over all. Some minor comments/fix are needed.

Copy link
Contributor

github-actions bot commented Mar 5, 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?

@github-actions github-actions bot removed the documentation Documentation related (improving, adding, etc) label Apr 15, 2025
@github-actions github-actions bot added the documentation Documentation related (improving, adding, etc) label Apr 15, 2025
@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc maintenance General maintenance of the repo (libraries, cicd, etc) labels Apr 16, 2025
@clatapie
Copy link
Contributor Author

The submodule is ready for another review if needed. Otherwise, it can be merged to feat/main_commands.
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 again -- up to @germa89 to merge

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.

Just wondering about table rendering. Please do double check those. Other than that, this is looking good to me for merging.

@clatapie clatapie merged commit 1c9ac58 into feat/main_commands Apr 23, 2025
43 checks passed
@clatapie clatapie deleted the feat/database_submodule branch April 23, 2025 08:36
@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
CI/CD Related with CICD, Github Actions, etc documentation Documentation related (improving, adding, etc) 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