Skip to content

Commit

Permalink
[REF] CI: Update CI/RTD (#123)
Browse files Browse the repository at this point in the history
* Update actions/checkout v2 -> v3

Node12 is used by v2 and will be deprecated so the update is necessary.

* Add html_theme to read the docs

Builds are failing on read the docs because html_theme is not defined,
this was being done on purpose (old style) but no longer seems to work.

Example of failing build:
https://readthedocs.org/projects/pre-commit-vauxoo/builds/21727547/
  • Loading branch information
antonag32 authored Aug 28, 2023
1 parent 50f293e commit 82dc379
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/github-actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ jobs:
with:
path: ~/.cache/pre-commit
key: ${{ runner.os }}-py${{ matrix.python }}-pre-commit
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: actions/setup-python@v4
Expand Down
7 changes: 1 addition & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# pylint: disable=invalid-name,redefined-builtin

import os

extensions = [
"sphinx.ext.autodoc",
Expand All @@ -27,12 +26,8 @@
"issue": ("https://github.com/Vauxoo/pre-commit-vauxoo/issues/%s", "#"),
"pr": ("https://github.com/Vauxoo/pre-commit-vauxoo/pull/%s", "PR #"),
}
# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get("READTHEDOCS", None) == "True"

if not on_rtd: # only set the theme if we're building docs locally
html_theme = "sphinx_rtd_theme"

html_theme = "sphinx_rtd_theme"
html_use_smartypants = True
html_last_updated_fmt = "%b %d, %Y"
html_split_index = False
Expand Down

0 comments on commit 82dc379

Please sign in to comment.