Skip to content

Commit ccd7ccc

Browse files
committed
docs: link brainpy.state relationship and fix stale doc URLs
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).
1 parent c211ae7 commit ccd7ccc

3 files changed

Lines changed: 15 additions & 3 deletions

File tree

‎brainpy/state/README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ The `brainpy.state` module provides a state-based programming interface for brai
66

77
State-based programming offers an alternative paradigm for defining and managing neural models, emphasizing explicit state management and transformations for building complex brain dynamics systems.
88

9+
`brainpy.state` is the recommended starting point for new `State`-based, differentiable models; the classic `DynamicalSystem`-based `brainpy` API (`brainpy.dyn`, `brainpy.math`, `brainpy.integrators`) is unchanged and fully supported. The two paradigms coexist — see the [relationship declaration](https://brainx.chaobrain.com/brainpy-state/project/relationship.html) for how they relate.
10+
911
## Features
1012

1113
- **Explicit State Management**: Clear separation between model state and computation logic
@@ -17,7 +19,7 @@ State-based programming offers an alternative paradigm for defining and managing
1719

1820
For comprehensive documentation on state-based programming in BrainPy, please visit:
1921

20-
- **State-based Documentation**: https://brainpy-state.readthedocs.io/
22+
- **State-based Documentation**: https://brainx.chaobrain.com/brainpy-state/
2123
- **Main BrainPy Documentation**: https://brainpy.readthedocs.io/
2224

2325
## Source Repository

‎docs/api.rst‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,17 @@ API Documentation
2020
apis/optim.rst
2121
apis/running.rst
2222
apis/mixin.rst
23-
``brainpy.state`` module <https://brainpy-state.readthedocs.io/api/index.html>
23+
``brainpy.state`` module <https://brainx.chaobrain.com/brainpy-state/apis/index.html>
24+
25+
.. admonition:: ``brainpy`` and ``brainpy.state``
26+
27+
``brainpy.state`` is the state-based modeling layer of BrainPy — developed and
28+
released as the standalone ``brainpy_state`` package and surfaced here through the
29+
``brainpy.state`` namespace (bundled with ``brainpy >= 2.7.6``; no separate install
30+
needed). It is the recommended starting point for new ``State``-based, differentiable
31+
spiking-network models, while the classic ``DynamicalSystem``-based API is unchanged
32+
and fully supported. See the `brainpy.state relationship page
33+
<https://brainx.chaobrain.com/brainpy-state/project/relationship.html>`_.
2434

2535
The following APIs will no longer be maintained in the future, but you can still use them normally.
2636

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Learn more
118118

119119
.. card:: :material-regular:`data_exploration;2em` ``brainpy.state`` APIs
120120
:class-card: sd-text-black sd-bg-light
121-
:link: https://brainpy-state.readthedocs.io/
121+
:link: https://brainx.chaobrain.com/brainpy-state/
122122

123123

124124
----

0 commit comments

Comments
 (0)