From 361c0b506cb6252d6a86837db516052ab6127b32 Mon Sep 17 00:00:00 2001 From: "Christopher K. Long" Date: Mon, 7 Apr 2025 16:21:04 +0100 Subject: [PATCH 1/2] Hidden toctree in user_guide index.rst --- docs/user_guide/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/user_guide/index.rst b/docs/user_guide/index.rst index 1cb2454..470f1ac 100644 --- a/docs/user_guide/index.rst +++ b/docs/user_guide/index.rst @@ -2,6 +2,7 @@ User Guide ========== .. toctree:: + :hidden: :titlesonly: getting_started From 56bceacf8c2118514e1781bcd4508b819122e9af Mon Sep 17 00:00:00 2001 From: "Christopher K. Long" Date: Mon, 7 Apr 2025 19:19:05 +0100 Subject: [PATCH 2/2] Changed documentation theme to Furo --- docs/conf.py | 3 +-- docs/requirements.txt | 1 + 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index ecb37f6..93cdea0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,8 +41,7 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'alabaster' -html_static_path = ['_static'] +html_theme = 'furo' import os import sys diff --git a/docs/requirements.txt b/docs/requirements.txt index fbbb494..5e03f88 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,5 +3,6 @@ tqdm numpy cloudpickle saveable-objects +furo myst-parser git+https://github.com/bayashi-cl/stubdoc \ No newline at end of file