update doc

chaobrain · Jun 8, 2024 · f490bd8 · f490bd8
1 parent c225fd9
commit f490bd8
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 35 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -5,8 +5,6 @@ API Documentation
    :maxdepth: 1
 
    apis/changelog.md
-   apis/functional.rst
-   apis/init.rst
-   apis/metric.rst
-   apis/optim.rst
+   apis/brainunit.rst
+   apis/brainunit.math.rst
 
diff --git a/docs/apis/brainunit.math.rst b/docs/apis/brainunit.math.rst
@@ -0,0 +1,9 @@
+``brainunit.math`` module
+==========================
+
+.. currentmodule:: brainunit.math
+.. automodule:: brainunit.math
+
+.. autosummary::
+   :toctree: generated/
+
diff --git a/docs/apis/math.rst b/docs/apis/math.rst
diff --git a/docs/auto_generater.py b/docs/auto_generater.py
@@ -320,7 +320,7 @@ def main():
   os.makedirs('apis/auto/', exist_ok=True)
 
   _write_module(module_name='brainunit',
-                filename='apis/math.rst',
+                filename='apis/brainunit.math.rst',
                 header='``brainunit.init`` module')
 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,7 +1,7 @@
 ``brainunit`` documentation
 ===========================
 
-`brainunit <https://github.com/brainpy/brainunit>`_ implements the common toolboxes for brain dynamics programming (BDP).
+`brainunit <https://github.com/brainpy/brainunit>`_ implements a unit system for brain dynamics programming (BDP).
 
 ----