From 6ad0c9d8e3cec6ab53807daa99899a2aa119a126 Mon Sep 17 00:00:00 2001 From: "russell@unturf.com" Date: Mon, 4 May 2026 09:13:14 -0400 Subject: [PATCH] docs: switch to sphinx-book-theme for unified right-side project TOC MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit sphinx_rtd_theme only renders left-side navigation. Switch to sphinx-book-theme which puts the full project TOC on the right and leaves the reading area centered. conf.py: - html_theme = 'sphinx_book_theme' - html_sidebars = {'**': []} hides the left sidebar so the right TOC is the single navigation surface - show_toc_level=3 expands subpages; show_navbar_depth=2 controls top nav requirements.txt: sphinx-rtd-theme → sphinx-book-theme>=1.1 --- docs/_source/conf.py | 15 ++++++++++++++- docs/_source/requirements.txt | 2 +- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/_source/conf.py b/docs/_source/conf.py index 3cb20f5..4390a7a 100644 --- a/docs/_source/conf.py +++ b/docs/_source/conf.py @@ -35,10 +35,23 @@ napoleon_numpy_docstring = True napoleon_attr_annotations = True # HTML output -html_theme = "sphinx_rtd_theme" +html_theme = "sphinx_book_theme" html_static_path = ["_static"] html_title = "Aborist API Reference" +# Move the project TOC to the right side. Reading area stays centered; +# left-side primary sidebar is hidden so the right TOC is the single +# navigation surface. +html_theme_options = { + "show_toc_level": 3, + "show_navbar_depth": 2, + "use_sidenotes": True, + "primary_sidebar_end": [], +} +html_sidebars = { + "**": [], # empty left sidebar — unified TOC lives on the right +} + # Suppress warnings for missing references suppress_warnings = ["ref.doc"] diff --git a/docs/_source/requirements.txt b/docs/_source/requirements.txt index 1cd72b0..f17958f 100644 --- a/docs/_source/requirements.txt +++ b/docs/_source/requirements.txt @@ -1,3 +1,3 @@ # Sphinx documentation build dependencies for Read the Docs sphinx>=8.0 -sphinx-rtd-theme>=3.0 +sphinx-book-theme>=1.1