Skip to content

Commit a3fd4e2

Browse files
committed
[doc] update documentation
1 parent bd1b2c1 commit a3fd4e2

File tree

6 files changed

+13
-26
lines changed

6 files changed

+13
-26
lines changed

brainpy/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@
5454
from brainpy import (channels, # channel models
5555
layers, # ANN layers
5656
neurons, # neuron groups
57+
synapses, # synapses
5758
rates, # rate models
5859
experimental,
5960
)
60-
from brainpy.synapses import (synapses, # synaptic dynamics
61-
synouts, # synaptic output
62-
synplast,) # synaptic plasticity
61+
from brainpy.synapses import (synouts, # synaptic output
62+
synplast, ) # synaptic plasticity
6363

6464
from brainpy._src.dynsys import (DynamicalSystem as DynamicalSystem,
6565
Container as Container,

brainpy/synapses/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
from .dynamics import *
3+
from .synouts import *
4+
from .synplast import *
5+
File renamed without changes.

docs/auto_generater.py

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -459,31 +459,17 @@ def generate_running_docs():
459459

460460
def generate_synapses_docs():
461461
_write_subsections_v2(
462-
'brainpy._src.dyn.synapses',
462+
'brainpy.synapses',
463463
'brainpy.synapses',
464464
'apis/auto/synapses.rst',
465465
subsections={
466-
'abstract_models': 'Abstract Models',
467-
'biological_models': 'Biological Models',
468-
'delay_couplings': 'Coupling Models',
469-
'gap_junction': 'Gap Junction Models',
470-
'learning_rules': 'Learning Rule Models',
466+
'dynamics': 'Synaptic Dynamics',
467+
'synouts': 'Synaptic Output',
468+
'synplast': 'Synaptic Plasticity',
471469
}
472470
)
473471

474472

475-
def generate_synouts_docs():
476-
_write_module(module_name='brainpy.synouts',
477-
filename='apis/auto/synouts.rst',
478-
header='``brainpy.synouts`` module')
479-
480-
481-
def generate_synplast_docs():
482-
_write_module(module_name='brainpy.synplast',
483-
filename='apis/auto/synplast.rst',
484-
header='``brainpy.synplast`` module')
485-
486-
487473
def generate_brainpy_docs():
488474
_write_subsections(
489475
module_name='brainpy',

docs/conf.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,6 @@
3535
auto_generater.generate_rates_docs()
3636
auto_generater.generate_running_docs()
3737
auto_generater.generate_synapses_docs()
38-
auto_generater.generate_synouts_docs()
39-
auto_generater.generate_synplast_docs()
4038
auto_generater.generate_brainpy_docs()
4139
auto_generater.generate_integrators_doc()
4240
auto_generater.generate_math_docs()

docs/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,10 @@ general-purpose Brain Dynamics Programming (BDP). Among its key ingredients, Bra
9696
apis/auto/brainpy.rst
9797
apis/auto/math.rst
9898
apis/auto/channels.rst
99-
apis/auto/layers.rst
10099
apis/auto/neurons.rst
101100
apis/auto/rates.rst
102101
apis/auto/synapses.rst
103-
apis/auto/synouts.rst
104-
apis/auto/synplast.rst
102+
apis/auto/layers.rst
105103
apis/auto/integrators.rst
106104
apis/auto/analysis.rst
107105
apis/auto/connect.rst

0 commit comments

Comments
 (0)