update doc (#3)

* update doc * update doc
chaobrain · Jun 8, 2024 · 7d4ad73 · 7d4ad73
1 parent 59f8fe0
commit 7d4ad73
Show file tree

Hide file tree

Showing 13 changed files with 794 additions and 657 deletions.
diff --git a/brainunit/_base.py b/brainunit/_base.py
@@ -947,11 +947,17 @@ def __init__(
       self,
       value: Any,
       dtype: bst.typing.DTypeLike = None,
-      unit: Dimension = DIMENSIONLESS,
+      unit: Union[Dimension, 'Unit'] = DIMENSIONLESS,
   ):
+    if isinstance(unit, Unit):
+      s = unit.value
+      unit = unit.unit
+    else:
+      s = None
+
     if isinstance(value, numbers.Number) and _allow_python_scalar_value:
       self._unit = unit
-      self._value = value
+      self._value = (value if s is None else (value * s))
       return
 
     if isinstance(value, (list, tuple)):
@@ -984,7 +990,7 @@ def __init__(
       raise TypeError(f"Invalid type for value: {type(value)}")
 
     # value
-    self._value = value
+    self._value = (value if s is None else (value * s))
 
     # unit
     self._unit = unit

diff --git a/brainunit/math/_utils.py b/brainunit/math/_utils.py
@@ -19,7 +19,7 @@
 
 from jax.tree_util import tree_map
 
-from brainunit import Quantity
+from .._base import Quantity
 
 
 def _as_jax_array_(obj):

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/brainunit.rst b/docs/apis/brainunit.rst
@@ -0,0 +1,42 @@
+``brainunit`` module
+====================
+
+.. currentmodule:: brainunit
+.. automodule:: brainunit
+
+
+
+Base Classes
+------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+    Quantity
+    Unit
+    DIMENSIONLESS
+    DimensionMismatchError
+
+
+Helper Functions
+----------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+    get_or_create_dimension
+    get_unit
+    get_basic_unit
+    is_unitless
+    have_same_unit
+    in_unit
+    in_best_unit
+    register_new_unit
+    check_units
+    is_scalar_type
+    fail_for_dimension_mismatch
+
diff --git a/docs/apis/functional.rst b/docs/apis/functional.rst
diff --git a/docs/apis/init.rst b/docs/apis/init.rst
diff --git a/docs/apis/metric.rst b/docs/apis/metric.rst
diff --git a/docs/apis/optim.rst b/docs/apis/optim.rst