improve docs layout

Daafip · Mar 7, 2024 · 8695409 · 8695409
1 parent 3bab975
commit 8695409
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 5 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -20,10 +20,20 @@
             ]
 
 templates_path = ['_templates']
-exclude_patterns = []
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
 
 source_suffix = [".rst"]
 
+html_sidebars = {
+    "**": [
+        "relations.html",  # needs 'show_related': True theme option to display
+        "searchbox.html",
+    ]
+}
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

diff --git a/docs/source/example_model_run_HBV.ipynb b/docs/source/example_model_run_HBV.ipynb
@@ -55,7 +55,7 @@
    "id": "111bc65b-8299-43ba-95fd-e92df6b92707",
    "metadata": {},
    "source": [
-    "#### set up paths"
+    "## set up paths"
    ]
   },
   {
@@ -86,7 +86,7 @@
    "id": "4787c692-3f9c-402b-9b48-93daeeb47926",
    "metadata": {},
    "source": [
-    "#### add parameter info"
+    "## add parameter info"
    ]
   },
   {
@@ -267,7 +267,7 @@
    "id": "1e320191-4ee4-4535-94f3-05e5afef96e2",
    "metadata": {},
    "source": [
-    "# Running model"
+    "## Running model"
    ]
   },
   {
@@ -308,7 +308,7 @@
    "id": "9b88262e-c750-4f8e-a602-50c404969690",
    "metadata": {},
    "source": [
-    "# Process results:"
+    "## Process results:"
    ]
   },
   {