Skip to content

Commit f7a5b22

Browse files
committed
Update documentation to reflect changes in module structure and versioning
1 parent d06bb47 commit f7a5b22

File tree

4 files changed

+7
-8
lines changed

4 files changed

+7
-8
lines changed

brainpy/__init__.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,6 @@
180180
analysis
181181
visualize
182182
train
183-
channels, neurons, synapses, rates, state_based, synouts, synplast
184-
modes
183+
channels, neurons, synapses, rates, synouts, synplast
185184
Base
186185
ArrayCollector, Collector, errors

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
except Exception as e:
2828
print(f"Error deleting {item}: {e}")
2929

30-
build_version = os.environ.get('CURRENT_VERSION', 'v2')
30+
build_version = os.environ.get('CURRENT_VERSION', 'v')
3131
if build_version == 'v2':
3232
shutil.copytree(
3333
os.path.join(os.path.dirname(__file__), '../docs_classic'),

docs_state/apis.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ API Reference
33

44
This page provides a comprehensive reference for all BrainPy APIs.
55

6-
.. currentmodule:: brainpy.state_based
7-
.. automodule:: brainpy.state_based
6+
.. currentmodule:: brainpy.state
7+
.. automodule:: brainpy.state
88

99

1010

docs_state/tutorials/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Tutorials
22
=========
33

4-
Welcome to the BrainPy 3.0 tutorials! These step-by-step guides will help you master computational neuroscience modeling with BrainPy.
4+
Welcome to the ``brainpy.state`` tutorials! These step-by-step guides will help you master computational neuroscience modeling with BrainPy.
55

66
Learning Path
77
-------------
@@ -15,7 +15,7 @@ We recommend following the tutorials in order:
1515
Basic Tutorials
1616
---------------
1717

18-
Start here to learn the fundamentals of BrainPy 3.0.
18+
Start here to learn the fundamentals of ``brainpy.state``.
1919

2020
Tutorial 1: LIF Neuron Basics
2121
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -256,7 +256,7 @@ Before starting the tutorials, ensure you have:
256256

257257
✅ Python 3.10 or later
258258

259-
BrainPy 3.0 installed (see :doc:`../quickstart/installation`)
259+
``brainpy.state`` installed (see :doc:`../quickstart/installation`)
260260

261261
✅ Basic Python knowledge (functions, classes, NumPy)
262262

0 commit comments

Comments
 (0)