mirror of
https://github.com/xonsh/xonsh.git
synced 2025-03-04 08:24:40 +01:00
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.
This commit is contained in:
parent
ed4421ddf4
commit
572ebb576d
4 changed files with 28 additions and 21 deletions
24
docs/conf.py
24
docs/conf.py
|
@ -156,29 +156,14 @@ modindex_common_prefix = ["xonsh."]
|
||||||
# documentation.
|
# documentation.
|
||||||
if not on_rtd:
|
if not on_rtd:
|
||||||
|
|
||||||
html_theme = "cloud"
|
html_theme = "furo"
|
||||||
|
|
||||||
html_theme_options = {
|
html_theme_options = {
|
||||||
"max_width": "1250px",
|
"source_repository": "https://github.com/xonsh/xonsh/",
|
||||||
"minimal_width": "700px",
|
"source_branch": "main",
|
||||||
"relbarbgcolor": "#000000",
|
"source_directory": "docs/",
|
||||||
"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",
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# 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
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
# "<project> v<release> documentation".
|
# "<project> v<release> documentation".
|
||||||
# html_title = None
|
# 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,
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
html_static_path = ["_static"]
|
html_static_path = ["_static"]
|
||||||
html_style = "numpy_friendly.css"
|
|
||||||
|
|
||||||
html_extra_path = ["_static/robots.txt"]
|
html_extra_path = ["_static/robots.txt"]
|
||||||
|
|
||||||
|
|
23
news/furo.rst
Normal file
23
news/furo.rst
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
**Added:**
|
||||||
|
|
||||||
|
* <news item>
|
||||||
|
|
||||||
|
**Changed:**
|
||||||
|
|
||||||
|
* New docs theme ``furo``
|
||||||
|
|
||||||
|
**Deprecated:**
|
||||||
|
|
||||||
|
* <news item>
|
||||||
|
|
||||||
|
**Removed:**
|
||||||
|
|
||||||
|
* <news item>
|
||||||
|
|
||||||
|
**Fixed:**
|
||||||
|
|
||||||
|
* <news item>
|
||||||
|
|
||||||
|
**Security:**
|
||||||
|
|
||||||
|
* <news item>
|
|
@ -137,7 +137,7 @@ dev = [
|
||||||
]
|
]
|
||||||
doc = [
|
doc = [
|
||||||
"xonsh[bestshell]",
|
"xonsh[bestshell]",
|
||||||
"cloud_sptheme",
|
"furo",
|
||||||
"numpydoc",
|
"numpydoc",
|
||||||
"sphinx>=3.1",
|
"sphinx>=3.1",
|
||||||
"psutil",
|
"psutil",
|
||||||
|
|
Loading…
Add table
Reference in a new issue