Skip to content

Commit

Permalink
Change sphinx theme to furo.
Browse files Browse the repository at this point in the history
  • Loading branch information
rcschrg committed Oct 16, 2024
1 parent 70f7411 commit d626313
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
-e .
sphinx-rtd-theme>=2.0.0
pika
pyzmq
furo>=2024.8.6
11 changes: 11 additions & 0 deletions docs/source/api_ref/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
8 changes: 7 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
}

0 comments on commit d626313

Please sign in to comment.