From d6263132d7bf4b8ab84234dd1d59dbbeb66e0bf7 Mon Sep 17 00:00:00 2001 From: Rico Schrage Date: Wed, 16 Oct 2024 22:21:47 +0200 Subject: [PATCH] Change sphinx theme to furo. --- docs/requirements.txt | 2 +- docs/source/api_ref/index.rst | 11 +++++++++++ docs/source/conf.py | 8 +++++++- 3 files changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index f5fd542..b44f58f 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -e . -sphinx-rtd-theme>=2.0.0 pika pyzmq +furo>=2024.8.6 diff --git a/docs/source/api_ref/index.rst b/docs/source/api_ref/index.rst index 2d77faa..25fc932 100644 --- a/docs/source/api_ref/index.rst +++ b/docs/source/api_ref/index.rst @@ -10,6 +10,17 @@ functions. :undoc-members: :imported-members: :inherited-members: + :exclude-members: PrintingAgent, DistributedClockManager, DistributedClockAgent + +.. autoclass:: mango.PrintingAgent + :members: + +.. autoclass:: mango.DistributedClockManager + :members: + +.. autoclass:: mango.DistributedClockAgent + :members: + .. note:: diff --git a/docs/source/conf.py b/docs/source/conf.py index c8e222a..b01c9e6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,9 +43,15 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "sphinx_rtd_theme" +html_theme = "furo" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] + +html_theme_options = { + "light_logo": "Logo_mango_ohne_sub.svg", + "dark_logo": "Logo_mango_ohne_sub_white.svg", + "sidebar_hide_name": True, +}