From 8f075cb9ff42dc611dce789384a70f6df2d480e2 Mon Sep 17 00:00:00 2001 From: chaoming Date: Sun, 13 Aug 2023 23:11:06 +0800 Subject: [PATCH] update docs --- docs/api.rst | 2 +- docs/index.rst | 20 ++++++------------- docs/toolboxes.rst | 2 +- ...n_dynamics_tutorials.rst => tutorials.rst} | 5 +++-- 4 files changed, 11 insertions(+), 18 deletions(-) rename docs/{brain_dynamics_tutorials.rst => tutorials.rst} (85%) diff --git a/docs/api.rst b/docs/api.rst index 31b2253e7..65bc5b088 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,5 @@ API Documentation -====== +================= .. toctree:: :maxdepth: 1 diff --git a/docs/index.rst b/docs/index.rst index 17fc6371f..d950a3d34 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -35,7 +35,7 @@ Features .. div:: sd-font-normal - Numerical methods for ODEs, SDEs, DDEs, FDEs, etc. + BrainPy provides various numerical integration methods for ODEs, SDEs, DDEs, FDEs, etc. .. grid-item:: :columns: 12 12 12 6 @@ -84,7 +84,7 @@ Features .. div:: sd-font-normal - BrainPy supports dynamics analysis for low- and high-dimensional systems, including phase plane analysis, bifurcation analysis, linearization analysis, and fixed/slow point finding. + BrainPy supports dynamics analysis for low- and high-dimensional systems, including phase plane, bifurcation, linearization, and fixed/slow point analysis. ---- @@ -130,7 +130,7 @@ Learn more .. grid-item:: :columns: 6 6 6 4 - .. card:: :material-regular:`science;2em` Brain Dynamics Tutorials + .. card:: :material-regular:`science;2em` BDP Tutorials :class-card: sd-text-black sd-bg-light :link: brain_dynamics_tutorials.html @@ -144,14 +144,14 @@ Learn more .. grid-item:: :columns: 6 6 6 4 - .. card:: :material-regular:`science;2em` Toolboxes + .. card:: :material-regular:`science;2em` BDP Toolboxes :class-card: sd-text-black sd-bg-light :link: toolboxes.html .. grid-item:: :columns: 6 6 6 4 - .. card:: :material-regular:`science;2em` Frequently Asked Questions + .. card:: :material-regular:`science;2em` FAQ :class-card: sd-text-black sd-bg-light :link: FAQ.html @@ -186,17 +186,9 @@ Learn more :caption: Tutorials core_concepts.rst - brain_dynamics_tutorials.rst + tutorials.rst advanced_tutorials.rst toolboxes.rst FAQ.rst api.rst - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/toolboxes.rst b/docs/toolboxes.rst index 20ef8a050..bbbcce48d 100644 --- a/docs/toolboxes.rst +++ b/docs/toolboxes.rst @@ -1,4 +1,4 @@ -Toolboxes +BDP Toolboxes ================== This section contains detailed toolboxes BrainPy uses for brain dynamics modeling. diff --git a/docs/brain_dynamics_tutorials.rst b/docs/tutorials.rst similarity index 85% rename from docs/brain_dynamics_tutorials.rst rename to docs/tutorials.rst index 3eaa49424..7c9a1c876 100644 --- a/docs/brain_dynamics_tutorials.rst +++ b/docs/tutorials.rst @@ -1,5 +1,6 @@ -Brain Dynamics Tutorials -======================== +BDP Tutorials +============= + This section contains tutorials on how to use BrainPy to accomplish model building, simulation, training, and analysis. .. toctree::