Skip to content

Commit 9fd679e

Browse files
authored
update docs and fix link bugs (#259)
update docs and fix link bugs
2 parents 2659a05 + 94118a7 commit 9fd679e

File tree

3 files changed

+300
-302
lines changed

3 files changed

+300
-302
lines changed

docs/tutorial_building/build_conductance_neurons.ipynb

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@
1111
"# Building Conductance-based Neuron Models"
1212
]
1313
},
14+
{
15+
"cell_type": "markdown",
16+
"metadata": {},
17+
"source": [
18+
"@[Xiaoyu Chen](mailto:[email protected]) "
19+
]
20+
},
1421
{
1522
"cell_type": "markdown",
1623
"metadata": {
@@ -34,7 +41,7 @@
3441
"source": [
3542
"On the other hand, simplified models do not care about the physiological features of neurons but mainly focus on how to reproduce the exact spike timing. Therefore, they are more simplified and maybe not biologically explicable.\n",
3643
"\n",
37-
"BrainPy provides a large volume of [predefined neuron models](../apis/auto/dyn/neurons.html) including conductance-based and simplified models for ease of use. In this section, we will only talk about how to build conductance-based models by ion channels. Users please refer to [Customizing Your Neuron Models](customize_neuron_models.ipynb) for more information."
44+
"BrainPy provides a large volume of [predefined neuron models](../apis/auto/dyn/neurons.rst) including conductance-based and simplified models for ease of use. In this section, we will only talk about how to build conductance-based models by ion channels. Users please refer to [Customizing Your Neuron Models](customize_neuron_models.ipynb) for more information."
3845
]
3946
},
4047
{
@@ -333,7 +340,7 @@
333340
"cell_type": "markdown",
334341
"metadata": {},
335342
"source": [
336-
"By combining different ion channels, we can get different types of conductance-based neuron models easily and straightforwardly. To see all predifined channel models in BrainPy, please click [here](../apis/dyn.html)."
343+
"By combining different ion channels, we can get different types of conductance-based neuron models easily and straightforwardly. To see all predifined channel models in BrainPy, please click [here](../apis/dyn.rst)."
337344
]
338345
},
339346
{

docs/tutorial_building/overview_of_dynamic_model.ipynb

Lines changed: 286 additions & 293 deletions
Large diffs are not rendered by default.

docs/tutorial_toolbox/synaptic_connections.ipynb

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@
7474
"metadata": {},
7575
"source": [
7676
"There are two classes inheriting from the base class `bp.conn.Connector`:\n",
77-
"- [bp.conn.TwoEndConnector](../apis/auto/building/generated/brainpy.building.connect.TwoEndConnector.rst): a connector to build synaptic connections **between two neuron groups**.\n",
78-
"- [bp.conn.OneEndConnector](../apis/auto/building/generated/brainpy.building.connect.OneEndConnector.rst): a connector to build synaptic connections **within a population of neurons**.\n",
77+
"- [bp.conn.TwoEndConnector](../apis/auto/generated/brainpy.building.connect.TwoEndConnector.rst): a connector to build synaptic connections **between two neuron groups**.\n",
78+
"- [bp.conn.OneEndConnector](../apis/auto/generated/brainpy.building.connect.OneEndConnector.rst): a connector to build synaptic connections **within a population of neurons**.\n",
7979
"\n",
8080
"Users can click the link of each class above to look through the API documentation."
8181
]
@@ -114,6 +114,7 @@
114114
},
115115
{
116116
"cell_type": "markdown",
117+
"metadata": {},
117118
"source": [
118119
"### Connector.build_conn()\n",
119120
"Users can customize the connection in `build_conn()` function. Notice there are three connection types users can provide:\n",
@@ -144,10 +145,7 @@
144145
"```\n",
145146
"\n",
146147
"After creating the synaptic connection, users can use the `require()` method to access some useful properties of the connection."
147-
],
148-
"metadata": {
149-
"collapsed": false
150-
}
148+
]
151149
},
152150
{
153151
"cell_type": "markdown",
@@ -2218,4 +2216,4 @@
22182216
},
22192217
"nbformat": 4,
22202218
"nbformat_minor": 4
2221-
}
2219+
}

0 commit comments

Comments
 (0)