docs: link brainpy.state relationship and fix stale doc URLs#873
Merged
Conversation
Add a brainpy.state relationship admonition to the API reference and point brainpy.state doc references at the canonical brainx.chaobrain.com/brainpy-state URLs (docs/api.rst, docs/index.rst card, brainpy/state/README.md), replacing the outdated brainpy-state.readthedocs.io links (the API link also had a wrong api/ -> apis/ path).
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates BrainPy state documentation to clarify the relationship between state-based and classic APIs and retargets all brainpy.state-related links to the new canonical docs host/paths. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
docs/api.rst: add abrainpy.staterelationship admonition; fix the module linkbrainpy-state.readthedocs.io/api/index.html-> canonicalbrainx.chaobrain.com/brainpy-state/apis/index.html(wrong host and wrongapi/->apis/path).docs/index.rst: fix thebrainpy.statecard link to the canonical URL.brainpy/state/README.md: add a relationship pointer and fix the State-based Documentation URL to canonical.Validation
sphinx -b dummy(notebook execution off): exit 0, no warnings on the edited files; all three canonical URLs return HTTP 200.🤖 Generated with Claude Code
Summary by Sourcery
Clarify how
brainpy.staterelates to the classic BrainPy API and update state-related documentation and links to use the canonical brainpy-state URLs.Enhancements:
brainpy.stateAPI and the classicDynamicalSystem-based BrainPy API in the state README.Documentation:
brainpy.stateand the classic BrainPy API in the state README and API docs.