From ee91f3ad6ce5b2a922cc5fd6b6cef5c743d14bd0 Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 28 Jun 2023 10:04:40 +0200 Subject: [PATCH 1/3] change theme --- docs-requirements.txt | 3 +-- docs/conf.py | 16 +++++++++------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs-requirements.txt b/docs-requirements.txt index 2a98682baa..813085c7d6 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -1,4 +1,3 @@ +shibuya sphinx==7.0.1 -sphinx-rtd-theme -sphinx-autodoc-typehints[type_comments]>=1.8.0 typing-extensions diff --git a/docs/conf.py b/docs/conf.py index 9dde301cfb..0420f7f5ef 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 @@ -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" @@ -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, @@ -167,7 +169,7 @@ "sentry-python Documentation", author, "sentry-python", - "One line description of project.", + "The official Sentry SDK for Python.", "Miscellaneous", ) ] From 2cc9987dbf7f4731b96d301d7f769c58e11550ce Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 28 Jun 2023 10:12:16 +0200 Subject: [PATCH 2/3] update python version for building apidocs --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8c397adabb..798768015b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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 From 4dd6a5597c2335ca5ecd2e3a361c291082a5b396 Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 28 Jun 2023 10:15:45 +0200 Subject: [PATCH 3/3] readd sphinx autodoc typehints --- docs-requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs-requirements.txt b/docs-requirements.txt index 813085c7d6..e1f694004b 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -1,3 +1,4 @@ shibuya sphinx==7.0.1 +sphinx-autodoc-typehints[type_comments]>=1.8.0 typing-extensions