Skip to content

Commit 754e1cb

Browse files
authored
chore(docs): use rtd theme (#238)
In order to resolve #237, this fixes the ability to deploy the docs to github pages via the github action. I tested this workflow on my branch and the output is here: https://adamweeks.github.io/WebexPythonSDK/ https://github.com/adamweeks/WebexPythonSDK/actions/runs/10291284373
2 parents 1f5cecc + e043953 commit 754e1cb

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

.github/workflows/docs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ jobs:
1616
id-token: write
1717
environment:
1818
name: github-pages
19+
url: ${{ steps.deployment.outputs.page_url }}
1920
env:
2021
POETRY_VIRTUALENVS_CREATE: false
2122
steps:

docs/conf.py

+3-6
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77

88
import webexpythonsdk
9+
import sphinx_rtd_theme
910

1011

1112
project = "webexpythonsdk"
@@ -52,13 +53,9 @@
5253
# a list of builtin themes.
5354
#
5455
# html_theme = 'alabaster'
55-
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
5656

57-
if not on_rtd:
58-
import sphinx_rtd_theme
59-
60-
html_theme = "sphinx_rtd_theme"
61-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
57+
html_theme = "sphinx_rtd_theme"
58+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
6259

6360
# Theme options are theme-specific and customize the look and feel of a theme
6461
# further. For a list of options available for each theme, see the

docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
sphinx_rtd_theme

0 commit comments

Comments
 (0)