From 572ebb576d9d8bb74d1c9dc447a0351ada049f2a Mon Sep 17 00:00:00 2001 From: Gil Forsyth Date: Wed, 18 May 2022 11:06:45 -0400 Subject: [PATCH] docs: change theme to furo (#4809) Trying out a new theme -- I really like the way `furo` looks and I think it makes it easier to navigate our overly dense docs pages. --- .../index.html | 0 docs/conf.py | 24 ++++--------------- news/furo.rst | 23 ++++++++++++++++++ pyproject.toml | 2 +- 4 files changed, 28 insertions(+), 21 deletions(-) rename docs/{_templates_overwrite => _templates}/index.html (100%) create mode 100644 news/furo.rst diff --git a/docs/_templates_overwrite/index.html b/docs/_templates/index.html similarity index 100% rename from docs/_templates_overwrite/index.html rename to docs/_templates/index.html diff --git a/docs/conf.py b/docs/conf.py index 8b6910d8a..9abb83c7b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -156,29 +156,14 @@ modindex_common_prefix = ["xonsh."] # documentation. if not on_rtd: - html_theme = "cloud" + html_theme = "furo" html_theme_options = { - "max_width": "1250px", - "minimal_width": "700px", - "relbarbgcolor": "#000000", - "footerbgcolor": "#FFFFE7", - "sidebarwidth": "322px", - "sidebarbgcolor": "#e7e7ff", - #'googleanalytics_id': 'UA-41934829-1', - "inline_admonitions": True, - "stickysidebar": False, - "highlighttoc": False, - "externalrefs": False, - "collapsiblesidebar": True, - "default_layout_text_size": "100%", # prevents division by zero error - "fontcssurl": "https://fonts.googleapis.com/css?family=Noticia+Text|Open+Sans|Droid+Sans+Mono", + "source_repository": "https://github.com/xonsh/xonsh/", + "source_branch": "main", + "source_directory": "docs/", } - # Add any paths that contain custom themes here, relative to this directory. - html_theme_path = ["_theme"] - templates_path = ["_templates_overwrite", "_templates"] - # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". # html_title = None @@ -199,7 +184,6 @@ html_favicon = "_static/magic_conch.ico" # 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_style = "numpy_friendly.css" html_extra_path = ["_static/robots.txt"] diff --git a/news/furo.rst b/news/furo.rst new file mode 100644 index 000000000..52a437434 --- /dev/null +++ b/news/furo.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* New docs theme ``furo`` + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* diff --git a/pyproject.toml b/pyproject.toml index ed78778b4..05770e53c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -137,7 +137,7 @@ dev = [ ] doc = [ "xonsh[bestshell]", - "cloud_sptheme", + "furo", "numpydoc", "sphinx>=3.1", "psutil",