pyprimemesh icon indicating copy to clipboard operation
pyprimemesh copied to clipboard

maint: Migrate autoAPI to ansys-sphinx-theme autoAPI

Open AlejandroFernandezLuces opened this issue 5 months ago • 4 comments

Description

Migrate to ansys-sphinx-theme autoAPI implementation. This way we can delegate maintenance to that repo.

Checklist

  • [x] I have tested my changes locally.
  • [x] I have added necessary documentation or updated existing documentation.
  • [x] I have followed the coding style guidelines of this project.
  • [x] I have added appropriate unit tests.
  • [x] I have reviewed my changes before submitting this pull request.
  • [x] I have linked the issue or issues that are solved to the PR if any.
  • [x] I have assigned this PR to myself.
  • [x] I have made sure that the title of my PR follows Conventional commits style (e.g. feat: wrap with feature edges)

AlejandroFernandezLuces avatar Jun 16 '25 14:06 AlejandroFernandezLuces

The documentation for this pull request will be available at https://prime.docs.pyansys.com/pull/1061. Please allow some time for the documentation to be deployed.

github-actions[bot] avatar Jun 16 '25 14:06 github-actions[bot]

Hi @rchopade7 @waltersma , I think there is conflicting feedback in the offline discussion. @Revathyvenugopal162 implemented the following top level approach:

image

But I believe Ravindra preferred another set of top level titles.. Could you clarify if this set is fine?

Also, I would say that if this is really urgent, we could merge this PR and leave further fixes for the following release.

AlejandroFernandezLuces avatar Jun 30 '25 15:06 AlejandroFernandezLuces

Hi @AlejandroFernandezLuces , @Revathyvenugopal162 the set you outline agrees with my understanding of what is required and my understanding of what @rchopade7 has requested also. I will let @rchopade7 confirm this so we are all aligned. Once we have the PR docs deployed we can validate all the changes.

waltersma avatar Jun 30 '25 15:06 waltersma

Hi @AlejandroFernandezLuces , @Revathyvenugopal162 the set you outline agrees with my understanding of what is required and my understanding of what @rchopade7 has requested also. I will let @rchopade7 confirm this so we are all aligned. Once we have the PR docs deployed we can validate all the changes.

Hi @Revathyvenugopal162 has implemented correst set of titles for API reference cc @waltersma @AlejandroFernandezLuces

rchopade7 avatar Jun 30 '25 16:06 rchopade7