Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs #443

Merged
merged 1 commit into from
Aug 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
API Documentation
======
=================

.. toctree::
:maxdepth: 1
Expand Down
20 changes: 6 additions & 14 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

----

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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`
2 changes: 1 addition & 1 deletion docs/toolboxes.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Toolboxes
BDP Toolboxes
==================
This section contains detailed toolboxes BrainPy uses for brain dynamics modeling.

Expand Down
5 changes: 3 additions & 2 deletions docs/brain_dynamics_tutorials.rst → docs/tutorials.rst
Original file line number Diff line number Diff line change
@@ -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::
Expand Down