Skip to content

Commit d26e4a9

Browse files
authored
Change API doc theme (#2210)
The previously used `alabaster` theme had issues with text overlapping.
1 parent d4ecab3 commit d26e4a9

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ jobs:
8484
- uses: actions/checkout@v2
8585
- uses: actions/setup-python@v4
8686
with:
87-
python-version: 3.9
87+
python-version: 3.11
8888

8989
- run: |
9090
pip install virtualenv

docs-requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1+
shibuya
12
sphinx==7.0.1
2-
sphinx-rtd-theme
33
sphinx-autodoc-typehints[type_comments]>=1.8.0
44
typing-extensions

docs/conf.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
import os
44
import sys
5-
65
import typing
6+
from datetime import datetime
77

88
# prevent circular imports
99
import sphinx.builders.html
1010
import sphinx.builders.latex
1111
import sphinx.builders.texinfo
1212
import sphinx.builders.text
13-
import sphinx.ext.autodoc
14-
import urllib3.exceptions
13+
import sphinx.ext.autodoc # noqa: F401
14+
import urllib3.exceptions # noqa: F401
1515

1616
typing.TYPE_CHECKING = True
1717

@@ -27,7 +27,7 @@
2727
# -- Project information -----------------------------------------------------
2828

2929
project = "sentry-python"
30-
copyright = "2019, Sentry Team and Contributors"
30+
copyright = "2019-{}, Sentry Team and Contributors".format(datetime.now().year)
3131
author = "Sentry Team and Contributors"
3232

3333
release = "1.26.0"
@@ -87,13 +87,15 @@
8787

8888
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
8989

90-
html_theme = "alabaster"
90+
html_theme = "shibuya"
9191

9292
# Theme options are theme-specific and customize the look and feel of a theme
9393
# further. For a list of options available for each theme, see the
9494
# documentation.
9595
#
96-
# html_theme_options = {}
96+
html_theme_options = {
97+
"github_url": "https://github.com/getsentry/sentry-python",
98+
}
9799

98100
# Add any paths that contain custom static files (such as style sheets) here,
99101
# relative to this directory. They are copied after the builtin static files,
@@ -167,7 +169,7 @@
167169
"sentry-python Documentation",
168170
author,
169171
"sentry-python",
170-
"One line description of project.",
172+
"The official Sentry SDK for Python.",
171173
"Miscellaneous",
172174
)
173175
]

0 commit comments

Comments
 (0)