Skip to content

docs: link brainpy.state relationship and fix stale doc URLs#873

Merged
chaoming0625 merged 1 commit into
mainfrom
docs/brainpy-state-relationship
Jul 22, 2026
Merged

docs: link brainpy.state relationship and fix stale doc URLs#873
chaoming0625 merged 1 commit into
mainfrom
docs/brainpy-state-relationship

Conversation

@chaoming0625

@chaoming0625 chaoming0625 commented Jul 22, 2026

Copy link
Copy Markdown
Member

Summary

  • docs/api.rst: add a brainpy.state relationship admonition; fix the module link brainpy-state.readthedocs.io/api/index.html -> canonical brainx.chaobrain.com/brainpy-state/apis/index.html (wrong host and wrong api/->apis/ path).
  • docs/index.rst: fix the brainpy.state card 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.state relates to the classic BrainPy API and update state-related documentation and links to use the canonical brainpy-state URLs.

Enhancements:

  • Clarify the relationship between the new State-based brainpy.state API and the classic DynamicalSystem-based BrainPy API in the state README.
  • Update documentation links in the state README and Sphinx docs to point to the canonical brainpy-state site and relationship page.

Documentation:

  • Add a relationship pointer between brainpy.state and the classic BrainPy API in the state README and API docs.
  • Fix stale and incorrect brainpy-state documentation URLs in the README, docs index, and API reference to use the canonical host and paths.

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).
@sourcery-ai

sourcery-ai Bot commented Jul 22, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates 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

Change Details Files
Clarify positioning of brainpy.state vs classic DynamicalSystem API and update state docs home URL to the canonical site.
  • Add a paragraph explaining that brainpy.state is the recommended entry point for new State-based differentiable models while the classic DynamicalSystem-based API remains supported.
  • Link to the official relationship declaration page describing how state-based and classic paradigms relate.
  • Change the State-based Documentation URL from the old readthedocs host to the canonical brainx.chaobrain.com/brainpy-state/ URL.
brainpy/state/README.md
Align brainpy.state references in Sphinx docs with the canonical brainpy-state documentation URLs and surface the relationship documentation.
  • In the API reference, add an admonition (relationship note) pointing to the brainpy.state relationship documentation so users understand how it fits with the rest of BrainPy.
  • Fix the brainpy.state API link host from brainpy-state.readthedocs.io to brainx.chaobrain.com and correct the path from /api/ to /apis/.
  • Update the brainpy.state card/link on the main docs index page to point to the new canonical documentation URL.
docs/api.rst
docs/index.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 22, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@chaoming0625
chaoming0625 merged commit 376d860 into main Jul 22, 2026
14 checks passed
@chaoming0625
chaoming0625 deleted the docs/brainpy-state-relationship branch July 22, 2026 10:03
@codecov

codecov Bot commented Jul 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant