Docs: Add links to dev docs in main user guide - #3412
Merged
Conversation
deruyter92
force-pushed
the
arash/dev_docs
branch
from
July 16, 2026 11:34
4fb98ae to
25b8dbb
Compare
Update the user guide to stop inlining API rst includes inside dropdown admonitions and instead link directly to the hosted API reference pages for each function. This streamlines the docs page, avoids include/eval-rst blocks, and normalizes admonition fencing where needed.
Corrected mismatched backtick fences in `docs/main-workflows/user-guide.md` so the API Docs admonition and the project configuration glossary section close properly and render as intended.
C-Achard
force-pushed
the
cy/user-guide-api-links
branch
from
July 16, 2026 13:28
4e42568 to
645b6c0
Compare
C-Achard
marked this pull request as ready for review
July 16, 2026 13:55
Collaborator
Author
|
@deruyter92 The links are functional! |
deruyter92
approved these changes
Jul 16, 2026
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
3 participants
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.
Replaces all .rst files in the main user guide with matching links to the API docs.