Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change API doc theme #2210

Merged
merged 5 commits into from
Jun 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-python@v4
with:
python-version: 3.9
python-version: 3.11

- run: |
pip install virtualenv
Expand Down
2 changes: 1 addition & 1 deletion docs-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
shibuya
sphinx==7.0.1
sphinx-rtd-theme
sphinx-autodoc-typehints[type_comments]>=1.8.0
typing-extensions
16 changes: 9 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

import os
import sys

import typing
from datetime import datetime

# prevent circular imports
import sphinx.builders.html
import sphinx.builders.latex
import sphinx.builders.texinfo
import sphinx.builders.text
import sphinx.ext.autodoc
import urllib3.exceptions
import sphinx.ext.autodoc # noqa: F401
import urllib3.exceptions # noqa: F401

typing.TYPE_CHECKING = True

Expand All @@ -27,7 +27,7 @@
# -- Project information -----------------------------------------------------

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

release = "1.26.0"
Expand Down Expand Up @@ -87,13 +87,15 @@

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

html_theme = "alabaster"
html_theme = "shibuya"

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

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