Skip to content

Commit

Permalink
update brainpy.dyn doc (#199)
Browse files Browse the repository at this point in the history
update brainpy.dyn doc
  • Loading branch information
chaoming0625 authored May 5, 2022
2 parents e4e1326 + 5f43ed3 commit 8060516
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/apis/dyn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@
auto/dyn/channels
auto/dyn/neurons
auto/dyn/synapses
auto/dyn/rates
auto/dyn/runners
14 changes: 11 additions & 3 deletions docs/auto_generater.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,8 +247,6 @@ def generate_dyn_docs(path='apis/auto/dyn/'):
('biological_models', 'Biological Models'),
('fractional_models', 'Fractional-order Models'),
('input_models', 'Input Models'),
('noise_models', 'Noise Models'),
('rate_models', 'Rate Models'),
('reduced_models', 'Reduced Models'),
]
write_submodules(module_name='brainpy.dyn.neurons',
Expand All @@ -260,7 +258,6 @@ def generate_dyn_docs(path='apis/auto/dyn/'):
module_and_name = [
('biological_models', 'Biological Models'),
('abstract_models', 'Abstract Models'),
('delay_coupling', 'Delay Coupling Models'),
('learning_rules', 'Learning Rule Models'),
]
write_submodules(module_name='brainpy.dyn.synapses',
Expand All @@ -269,6 +266,17 @@ def generate_dyn_docs(path='apis/auto/dyn/'):
submodule_names=[a[0] for a in module_and_name],
section_names=[a[1] for a in module_and_name])

module_and_name = [
('populations', 'Population Models'),
('couplings', 'Coupling Models'),
('noises', 'Noise Models'),
]
write_submodules(module_name='brainpy.dyn.rates',
filename=os.path.join(path, 'rates.rst'),
header='Rate Models',
submodule_names=[a[0] for a in module_and_name],
section_names=[a[1] for a in module_and_name])

write_module(module_name='brainpy.dyn.runners',
filename=os.path.join(path, 'runners.rst'),
header='Runners')
Expand Down

0 comments on commit 8060516

Please sign in to comment.