Add docs for fft module

chaobrain · Dec 6, 2024 · acaaf81 · acaaf81
1 parent 5af0051
commit acaaf81
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/auto_generater.py b/docs/auto_generater.py
@@ -355,6 +355,16 @@ def main():
                     submodule_names=[k[0] for k in module_and_name],
                     section_names=[k[1] for k in module_and_name])
 
+  module_and_name = [
+    ('_fft_change_unit', 'Functions that Changing Unit'),
+    ('_fft_keep_unit', 'Functions that Keeping Unit'),
+  ]
+
+  _write_submodules(module_name='brainunit.fft',
+                    filename='apis/brainunit.fft.rst',
+                    header='``brainunit.fft`` module',
+                    submodule_names=[k[0] for k in module_and_name],
+                    section_names=[k[1] for k in module_and_name])
 
 if __name__ == '__main__':
   main()
diff --git a/docs/index.rst b/docs/index.rst
@@ -191,6 +191,7 @@ We are building the `brain dynamics programming ecosystem <https://ecosystem-for
    apis/brainunit.math.rst
    apis/brainunit.linalg.rst
    apis/brainunit.lax.rst
+   apis/brainunit.fft.rst