From f51578b2d16a8d370a48149ad6b055f598944b42 Mon Sep 17 00:00:00 2001
From: shimwell <mail@jshimwell.com>
Date: Sat, 12 Oct 2024 01:04:59 +0100
Subject: [PATCH] improved docs

---
 docs/conf.py        | 14 +++++++-------
 docs/examples.rst   | 10 +++++-----
 docs/index.rst      | 15 ++++++---------
 docs/python_api.rst |  3 ---
 4 files changed, 18 insertions(+), 24 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index 0d8c04c1..a9956bd1 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -68,14 +68,14 @@
         "json_url": "https://raw.githubusercontent.com/fusion-energy/paramak/main/docs/version_switcher.json",
         "version_match": version_match,
     },
-    # "navbar_start": ["version-switcher", "navbar-icon-links"],
-    # "show_nav_level": 3,
-    # "collapse_navigation": True,
-    # "show_version_warning_banner": True,
+    "navbar_start": ["version-switcher", "navbar-icon-links"],
+    "show_nav_level": 3,
+    "collapse_navigation": True,
+    "show_version_warning_banner": True,
+}
+html_sidebars = {
+    "**": ["sidebar-nav-bs"]
 }
-# html_sidebars = {
-#     "**": ["sidebar-nav-bs", "sidebar-ethical-ads"]
-# }
 
 html_favicon = '_static/favicon.ico'
 master_doc = "index"
diff --git a/docs/examples.rst b/docs/examples.rst
index 37975f2c..efef2f85 100644
--- a/docs/examples.rst
+++ b/docs/examples.rst
@@ -1,5 +1,5 @@
-Usage
-=====
+Examples
+========
 
 There are two main reactors to choose from:
 
@@ -25,7 +25,7 @@ These examples show how to make various reactors with different options.
 .. toctree::
    :maxdepth: 3
 
-   usage_vis
-   usage_tokamak
-   usage_spherical_tokamak
+   examples_vis
+   examples_tokamak
+   examples_spherical_tokamak
 
diff --git a/docs/index.rst b/docs/index.rst
index c4ce679e..e624c931 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,22 +2,18 @@
 Paramak documentation
 =====================
 
-**Version**: |version|
 
 
-.. toctree::
-   :maxdepth: 1
+**Version**: |version|
 
-   install
 
 .. toctree::
    :maxdepth: 3
+   :caption: Contents:
+   :hidden:
 
+   install
    examples
-
-.. toctree::
-   :maxdepth: 1
-
    python_api
 
 Parameter driven CAD creation for fusion reactors.
@@ -51,7 +47,7 @@ The style of reaction, sizes of components, plasma shape and number of radial or
 
         Examples
         ^^^
-\
+
         .. button-ref:: examples
             :expand:
             :color: secondary
@@ -72,3 +68,4 @@ The style of reaction, sizes of components, plasma shape and number of radial or
             :click-parent:
 
             To the reference guide
+
diff --git a/docs/python_api.rst b/docs/python_api.rst
index d4504f06..33703d0b 100644
--- a/docs/python_api.rst
+++ b/docs/python_api.rst
@@ -8,11 +8,8 @@ Assemblies
 ----------
 
 .. autofunction:: tokamak
-
 .. autofunction:: tokamak_from_plasma
-    
 .. autofunction:: spherical_tokamak
-
 .. autofunction:: spherical_tokamak_from_plasma
 
 Workplanes