Skip to content

Commit dd64387

Browse files
committed
build: TEST
Probably lost with commit ca7f8b9 "Migrate to use .readthedocs.yaml for docs generation".
1 parent dd99a1c commit dd64387

File tree

4 files changed

+9
-4
lines changed

4 files changed

+9
-4
lines changed

.github/workflows/ci.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ jobs:
2121
- name: Set up Python
2222
uses: actions/setup-python@v5
2323
- run:
24-
pip install flake8 flake8-import-order sphinx rstcheck[sphinx] doc8
24+
pip install flake8 flake8-import-order sphinx sphinx_rtd_theme
25+
rstcheck[sphinx] doc8
2526
- run: pip install .
2627
- run: flake8 .
2728
- run: doc8 $(git ls-files '*.rst')

.readthedocs.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ version: 2
33
build:
44
os: ubuntu-22.04
55
tools:
6-
python: "3.11"
6+
python: "3.12"
77
sphinx:
88
configuration: docs/conf.py
9+
python:
10+
install:
11+
- requirements: docs/requirements.txt

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
from unittest.mock import MagicMock
77

88
sys.path.insert(0, os.path.abspath('..'))
9-
109
from yamllint import __copyright__, APP_NAME, APP_VERSION # noqa: I001, E402
1110

1211
# -- General configuration ------------------------------------------------
1312

1413
extensions = [
14+
'sphinx_rtd_theme',
1515
'sphinx.ext.autodoc',
1616
]
1717

@@ -29,7 +29,7 @@
2929

3030
# -- Options for HTML output ----------------------------------------------
3131

32-
html_theme = 'default'
32+
html_theme = 'sphinx_rtd_theme'
3333

3434
htmlhelp_basename = 'yamllintdoc'
3535

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
sphinx-rtd-theme >=2.0.0

0 commit comments

Comments
 (0)