Add main preCICE API guide to documentation navigation - #261
Merged
MakisH merged 2 commits intoOct 1, 2026
Merged
Conversation
Member
|
@Shubham-Padkonde thank you for the fix! To make reviewing easier, could you please add a screenshot of how this looks like? |
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The focused documentation change correctly addresses the linked issue without introducing unresolved concerns.
Review effort: Balanced
Findings: None
What changed in this PR
Adds a sidebar link from the Python bindings documentation to the main preCICE coupling API guide, resolving #258.
Changes:
- Adds a dedicated preCICE navigation section.
- Links to the external coupling API overview.
| File | Description |
|---|---|
docs/index.rst |
Adds the coupling API overview to documentation navigation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
Author
|
MakisH
reviewed
Sep 30, 2026
MakisH
approved these changes
Oct 1, 2026
Member
|
I triggered the workflow; this is now rendered in https://api.precice.org/python/develop/ It will be brought to https://api.precice.org/python/latest/ in the next release. |
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.
Fixes #258.
Add a preCICE navigation section linking to the main coupling API overview, so readers arriving directly at the Python bindings reference can find the broader project documentation from the sidebar.
Validation: built a navigation-only Sphinx fixture using the changed index and the repository's Read the Docs theme with warnings treated as errors; verified the link is present on the index and all three child pages. The target URL loads successfully and
git diff --checkpasses. The full autodoc build was not run because the compiled preCICE bindings are not installed locally.Prepared with Codex assistance.