Skip to content

Commit 5a6bd25

Browse files
committed
Enable and configure Furo theme.
This removes two features from the sidebar: the GitHub "stars" count and the Tidelift banner.
1 parent 323c932 commit 5a6bd25

File tree

6 files changed

+29
-17
lines changed

6 files changed

+29
-17
lines changed

Diff for: docs/Makefile

+3
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@ help:
1818
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1919
%: Makefile
2020
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21+
22+
livehtml:
23+
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Diff for: docs/_static/favicon.ico

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../logo/favicon.ico

Diff for: docs/conf.py

+20-17
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,11 @@
3636
"sphinx.ext.intersphinx",
3737
"sphinx.ext.viewcode",
3838
"sphinx_autodoc_typehints",
39+
"sphinx_copybutton",
40+
"sphinx_inline_tabs",
3941
"sphinxcontrib.spelling",
4042
"sphinxcontrib_trio",
43+
"sphinxext.opengraph",
4144
]
4245

4346
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
@@ -57,29 +60,29 @@
5760

5861
# The theme to use for HTML and HTML Help pages. See the documentation for
5962
# a list of builtin themes.
60-
html_theme = "alabaster"
63+
html_theme = "furo"
6164

6265
html_theme_options = {
63-
"logo": "websockets.svg",
64-
"description": "A library for building WebSocket servers and clients in Python with a focus on correctness and simplicity.",
65-
"github_button": True,
66-
"github_type": "star",
67-
"github_user": "aaugustin",
68-
"github_repo": "websockets",
69-
"tidelift_url": "https://tidelift.com/subscription/pkg/pypi-websockets?utm_source=pypi-websockets&utm_medium=referral&utm_campaign=docs",
66+
"light_css_variables": {
67+
"color-brand-primary": "#306998", # blue from logo
68+
"color-brand-content": "#0b487a", # blue more saturated and less dark
69+
},
70+
"dark_css_variables": {
71+
"color-brand-primary": "#ffd43bcc", # yellow from logo, more muted than content
72+
"color-brand-content": "#ffd43bd9", # yellow from logo, transparent like text
73+
},
74+
"sidebar_hide_name": True,
7075
}
7176

72-
html_sidebars = {
73-
"**": [
74-
"about.html",
75-
"searchbox.html",
76-
"navigation.html",
77-
"relations.html",
78-
"donate.html",
79-
]
80-
}
77+
html_logo = "_static/websockets.svg"
78+
79+
html_favicon = "_static/favicon.ico"
8180

8281
# Add any paths that contain custom static files (such as style sheets) here,
8382
# relative to this directory. They are copied after the builtin static files,
8483
# so a file named "default.css" will overwrite the builtin "default.css".
8584
html_static_path = ["_static"]
85+
86+
html_copy_source = False
87+
88+
html_show_sphinx = False

Diff for: docs/requirements.txt

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1+
furo
12
sphinx
3+
sphinx-autobuild
24
sphinx-autodoc-typehints
5+
sphinx-copybutton
6+
sphinx-inline-tabs
37
sphinxcontrib-spelling
48
sphinxcontrib-trio
9+
sphinxext-opengraph

Diff for: experiments/authentication/favicon.ico

-5.3 KB
Binary file not shown.

Diff for: experiments/authentication/favicon.ico

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../logo/favicon.ico

Diff for: logo/favicon.ico

5.3 KB
Binary file not shown.

0 commit comments

Comments
 (0)