update docs html title and sidebar contents

GStechschulte · Aug 19, 2023 · efdb1ab · efdb1ab
1 parent 41c5d85
commit efdb1ab
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,8 +40,8 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-# html_theme = 'alabaster'
 html_theme = 'sphinx_book_theme'
+html_title = "filterjax"
 html_theme_options = {
     'repository_url': 'https://github.com/GStechschulte/filterjax',
     "use_repository_button": True,

diff --git a/docs/index.rst b/docs/index.rst
@@ -13,11 +13,17 @@ Installation and Testing
 
 To install filterjax...
 
+Tutorials
+=========
+
+The tutorials below will introduce you to Kalman Filters in filterjax.
+
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 1
+   :caption: Kalman Filter:
 
-   examples
+   notebooks/dog_sensor.ipynb
+   .. examples
 
 Indices and tables
 ==================