From 5f43ed3516f9ad49dbc2a9211f4721fca4d949b3 Mon Sep 17 00:00:00 2001 From: chaoming Date: Thu, 5 May 2022 13:23:48 +0800 Subject: [PATCH] update brainpy.dyn doc --- docs/apis/dyn.rst | 1 + docs/auto_generater.py | 14 +++++++++++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/apis/dyn.rst b/docs/apis/dyn.rst index d3bab9556..2d3447c6e 100644 --- a/docs/apis/dyn.rst +++ b/docs/apis/dyn.rst @@ -12,4 +12,5 @@ auto/dyn/channels auto/dyn/neurons auto/dyn/synapses + auto/dyn/rates auto/dyn/runners \ No newline at end of file diff --git a/docs/auto_generater.py b/docs/auto_generater.py index 222232f36..2561bf155 100644 --- a/docs/auto_generater.py +++ b/docs/auto_generater.py @@ -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', @@ -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', @@ -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')