Skip to content

Commit

Permalink
build: TEST
Browse files Browse the repository at this point in the history
Probably lost with commit ca7f8b9 "Migrate to use .readthedocs.yaml for
docs generation".
  • Loading branch information
adrienverge committed Feb 6, 2024
1 parent dd99a1c commit dd64387
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v5
- run:
pip install flake8 flake8-import-order sphinx rstcheck[sphinx] doc8
pip install flake8 flake8-import-order sphinx sphinx_rtd_theme
rstcheck[sphinx] doc8
- run: pip install .
- run: flake8 .
- run: doc8 $(git ls-files '*.rst')
Expand Down
5 changes: 4 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.11"
python: "3.12"
sphinx:
configuration: docs/conf.py
python:
install:
- requirements: docs/requirements.txt
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
from unittest.mock import MagicMock

sys.path.insert(0, os.path.abspath('..'))

from yamllint import __copyright__, APP_NAME, APP_VERSION # noqa: I001, E402

# -- General configuration ------------------------------------------------

extensions = [
'sphinx_rtd_theme',
'sphinx.ext.autodoc',
]

Expand All @@ -29,7 +29,7 @@

# -- Options for HTML output ----------------------------------------------

html_theme = 'default'
html_theme = 'sphinx_rtd_theme'

htmlhelp_basename = 'yamllintdoc'

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 >=2.0.0

0 comments on commit dd64387

Please sign in to comment.