Issue 1920 - Adds missing doxygen links to RST#1935
Open
Rohit-Kakodkar wants to merge 1 commit into
Open
Conversation
- [x] Several docs changes
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Sphinx/Doxygen API documentation pages to add missing namespace/function links and to include new API sections (chunk_face and constants) in the main specfem API toctree.
Changes:
- Updated several API RST pages to use fully-qualified symbol headings and/or add
.. doxygennamespace::blocks for better Doxygen cross-linking. - Added new API documentation sections for
specfem::constantsandspecfem::chunk_face. - Wired the new sections into
docs/sections/api/specfem/index.rst.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/sections/api/specfem/utilities/strings.rst | Uses fully-qualified function headings for improved Doxygen cross-references. |
| docs/sections/api/specfem/units/conversions.rst | Converts the page to a direct unit_cast API entry. |
| docs/sections/api/specfem/tag_dispatch/index.rst | Adds doxygennamespace for specfem::tag_dispatch (desc-only). |
| docs/sections/api/specfem/io/backends/index.rst | Updates namespace naming to specfem::io_backends and adds doxygennamespace. |
| docs/sections/api/specfem/index.rst | Adds chunk_face and constants sections to the main API toctree. |
| docs/sections/api/specfem/constants/index.rst | New page documenting key constants via doxygenvariable. |
| docs/sections/api/specfem/chunk_face/index.rst | New chunk_face namespace landing page + toctree. |
| docs/sections/api/specfem/chunk_face/acceleration.rst | New page documenting specfem::chunk_face::acceleration. |
| docs/sections/api/specfem/chunk_face/velocity.rst | New page documenting specfem::chunk_face::velocity. |
| docs/sections/api/specfem/chunk_face/displacement.rst | New page documenting specfem::chunk_face::displacement. |
| docs/sections/api/specfem/chunk_face/chunk_face_index.rst | New page documenting specfem::chunk_face::Index. |
| docs/sections/api/specfem/chunk_face/nonconforming_interface.rst | New page documenting nonconforming-interface related chunk_face structs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Please describe the changes/features in this pull request.
Issue Number
If there is an issue created for these changes, link it here
Checklist
Please make sure to check developer documentation on specfem docs.