Skip to content

Commit

Permalink
chore(docs): use rtd theme (#238)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
Joezanini authored Aug 7, 2024
2 parents 1f5cecc + e043953 commit 754e1cb
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ jobs:
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
env:
POETRY_VIRTUALENVS_CREATE: false
steps:
Expand Down
9 changes: 3 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@


import webexpythonsdk
import sphinx_rtd_theme


project = "webexpythonsdk"
Expand Down Expand Up @@ -52,13 +53,9 @@
# a list of builtin themes.
#
# html_theme = 'alabaster'
on_rtd = os.environ.get("READTHEDOCS", None) == "True"

if not on_rtd:
import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# 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
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx_rtd_theme

0 comments on commit 754e1cb

Please sign in to comment.