Skip to content

docs: fix broken inner links - #465

Merged
SMoraisAnsys merged 8 commits into
mainfrom
docs/add-template
Feb 24, 2025
Merged

SMoraisAnsys merged 8 commits into
mainfrom
docs/add-template

Conversation

@SMoraisAnsys

Copy link
Copy Markdown
Contributor

Description

Following the breaking changes introduced in #452, this PR adds templates for modules and classes to ensure that inner classes are handled correctly.

Issue linked

None

Checklist

  • I have tested my changes locally.
  • I have added necessary documentation or updated existing documentation.
  • I have followed the coding style guidelines of this project.
  • I have added appropriate tests (unit, integration, system).
  • I have reviewed my changes before submitting this pull request.
  • I have linked the issue or issues that are solved by the PR if any.
  • I have assigned this PR to myself.
  • I have made sure that the title of my PR follows Conventional commits style (e.g. feat: add optical property)
  • I have agreed with the Contributor License Agreement (CLA).

@SMoraisAnsys SMoraisAnsys self-assigned this Feb 20, 2025
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Feb 20, 2025
@SMoraisAnsys
SMoraisAnsys marked this pull request as draft February 20, 2025 16:29
@SMoraisAnsys

Copy link
Copy Markdown
Contributor Author

Converting this PR into draft as @Revathyvenugopal162 might have implemented a solution from ansys-sphinx-theme side.

@github-actions github-actions Bot added the maintenance Package and maintenance related label Feb 20, 2025
@SMoraisAnsys

Copy link
Copy Markdown
Contributor Author

I've updated the build and conf.py. This should be working once ansys/ansys-sphinx-theme#630 is merged and a new release of ansys-sphinx-theme is performed.

@SMoraisAnsys
SMoraisAnsys marked this pull request as ready for review February 21, 2025 11:13
@SMoraisAnsys

Copy link
Copy Markdown
Contributor Author

Thanks @Revathyvenugopal162 for the bugfix :)

@SMoraisAnsys SMoraisAnsys changed the title docs: add autoapi templates docs: fix broken inner links Feb 21, 2025
@SMoraisAnsys
SMoraisAnsys merged commit 450d6c3 into main Feb 24, 2025
@SMoraisAnsys
SMoraisAnsys deleted the docs/add-template branch February 24, 2025 08:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation maintenance Package and maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants