doc: doc update

Dengyu-Wu · Jun 28, 2024 · d3a0b60 · d3a0b60
1 parent 578f570
commit d3a0b60
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 11 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -29,6 +29,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = 'sphinx_book_theme'
+html_title = 'SNNCutoff Documentation'
 html_static_path = ['_static']
 html_logo = "_static/light_mode.png"
 html_favicon = "_static/snncutoff_favicon.png"
@@ -38,4 +39,6 @@
     "use_repository_button": True,
 }
 
-html_sidebars = {'**': ['localtoc.html', 'globaltoc.html', 'searchbox.html']}
+html_sidebars = {
+    "**": ["sbt-sidebar-nav.html", "navbar-logo.html", "icon-links.html"]
+}
diff --git a/docs/cutoff/topk.md b/docs/cutoff/topk.md
@@ -0,0 +1,11 @@
+# Top-K
+
+## Training
+
+```sh
+sh scripts/DirectTraining/tet/training.sh
+```
+## Evaluation
+```sh
+sh scripts/DirectTraining/tet/evaluation.sh
+```
diff --git a/docs/index.md b/docs/index.md
@@ -4,8 +4,12 @@
 % contain the root `toctree` directive.
 
 ```{toctree}
-:hidden:
-tutorials/quick_start
+:caption: 'Tutorials'
+tutorials/installation
+tutorials/examples
+:caption: 'Cutoff'
+cutoff/topk
+:caption: 'References'
 references
 ```
 

diff --git a/docs/tutorials/quick_start.rst b/docs/tutorials/quick_start.rst