Skip to content

Commit 9047f79

Browse files
committed
add the beautiful logo as a favicon
1 parent f1014e1 commit 9047f79

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

docs/_static/favicon.ico

15 KB
Binary file not shown.

docs/conf.py

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
import os, sys
1+
import os
2+
import sys
3+
24
sys.path.insert(0, os.path.abspath("."))
35

46
import time
57
from importlib.metadata import version as package_version
68

7-
89
project = "Amaranth language & toolchain"
9-
version = package_version('amaranth').replace(".editable", "")
10+
version = package_version("amaranth").replace(".editable", "")
1011
release = version.split("+")[0]
1112
copyright = time.strftime("2020—%Y, Amaranth project contributors")
1213

1314
extensions = [
14-
"sphinx.ext.intersphinx",
15-
"sphinx.ext.doctest",
15+
"sphinx.ext.intersphinx",
16+
"sphinx.ext.doctest",
1617
"sphinx.ext.todo",
1718
"sphinx.ext.autodoc",
1819
"sphinx.ext.napoleon",
@@ -33,9 +34,7 @@
3334
todo_include_todos = True
3435

3536
autodoc_member_order = "bysource"
36-
autodoc_default_options = {
37-
"members": True
38-
}
37+
autodoc_default_options = {"members": True}
3938
autodoc_preserve_defaults = True
4039
autodoc_inherit_docstrings = False
4140

@@ -49,16 +48,20 @@
4948
napoleon_include_init_with_doc = True
5049
napoleon_include_special_with_doc = True
5150
napoleon_custom_sections = [
52-
("Attributes", "params_style"), # by default displays as "Variables", which is confusing
53-
("Members", "params_style"), # `lib.wiring` signature members
54-
"Platform overrides"
51+
(
52+
"Attributes",
53+
"params_style",
54+
), # by default displays as "Variables", which is confusing
55+
("Members", "params_style"), # `lib.wiring` signature members
56+
"Platform overrides",
5557
]
5658

5759
html_theme = "sphinx_rtd_theme"
5860
html_static_path = ["_static"]
5961
html_css_files = ["custom.css"]
6062
html_js_files = ["version-switch.js"]
6163
html_logo = "_static/logo.png"
64+
html_favicon = "_static/favicon.ico"
6265

6366
rst_prolog = """
6467
.. role:: py(code)
@@ -70,7 +73,7 @@
7073
# Picked up automatically by ReST and doesn't have an index.
7174
r"^https://amaranth-lang\.org/schema/$",
7275
# Rejects requests from GHA infra.
73-
r"^https://.+\.sourceforge\.net/"
76+
r"^https://.+\.sourceforge\.net/",
7477
]
7578

7679
linkcheck_anchors_ignore_for_url = [
@@ -84,4 +87,5 @@
8487
# Silence the warnings globally; otherwise they may fire on object destruction and crash completely
8588
# unrelated tests.
8689
import amaranth._unused
90+
8791
amaranth._unused.MustUse._MustUse__silence = True

0 commit comments

Comments
 (0)