Fix docs

chaobrain · Nov 24, 2024 · dc7ef21 · dc7ef21
1 parent c4891ca
commit dc7ef21
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -29,9 +29,13 @@
 import os
 import sys
 
+sys.path.insert(0, os.path.abspath(os.path.curdir))
 sys.path.insert(0, os.path.abspath('../'))
 
 import braintaichi
+import auto_generater
+
+os.makedirs('api', exist_ok=True)
 
 
 # -- Project information -----------------------------------------------------
@@ -57,6 +61,7 @@
   'sphinx.ext.viewcode',
   'sphinx_autodoc_typehints',
   'myst_nb',
+  'matplotlib.sphinxext.plot_directive',
   'sphinx_thebe',
   'sphinx_design'
 ]
@@ -118,7 +123,7 @@
 
 
 html_theme_options = {
-    'show_toc_level': 2,
+    'show_toc_level': 1,
 }
 
 # -- Options for myst ----------------------------------------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -23,13 +23,22 @@ See also the BDP ecosystem
 
 We are building the `brain dynamics programming ecosystem <https://ecosystem-for-brain-dynamics.readthedocs.io/>`_.
 
-
 ----
 
-
 .. toctree::
-   :hidden:
-   :maxdepth: 2
+   :maxdepth: 1
+   :caption: Tutorial
+
    tutorial/braintaichi_intro.ipynb
-   api.rst
+   tutorial/complete_example.ipynb
 
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API Documentation
+
+   apis/changelog.md
+   apis/operator-registration.rst
+   apis/sparse-operators.rst
+   apis/event-operators.rst
+   apis/jitconn-operators.rst