doc: make CI fail if the documentation generation raise warnings

This commit is contained in:
Éloi Rivard 2024-12-05 11:03:26 +01:00
parent c2101f91da
commit 650391891a
No known key found for this signature in database
GPG key ID: 7EDA204EA57DD184
4 changed files with 3 additions and 4 deletions

View file

@ -108,4 +108,4 @@ jobs:
- run: |
export TZ=UTC
uv sync --group doc
uv run sphinx-build doc build/sphinx/html
uv run sphinx-build doc build/sphinx/html --fail-on-warning

View file

@ -78,5 +78,5 @@ doc:
stage: test
script:
- uv sync --group doc
- uv run sphinx-build doc build/sphinx/html
- uv run sphinx-build doc build/sphinx/html --fail-on-warning
- uv cache prune --ci

View file

@ -56,7 +56,6 @@ exclude_patterns = []
pygments_style = "sphinx"
todo_include_todos = True
toctree_collapse = False
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"authlib": ("https://docs.authlib.org/en/latest", None),

View file

@ -239,7 +239,7 @@ basepython = ["python3.10"]
[tool.tox.env.doc]
dependency_groups = ["doc"]
commands = [
["sphinx-build", "--builder", "html", "doc", "build/sphinx/html"],
["sphinx-build", "--builder", "html", "--fail-on-warning", "doc", "build/sphinx/html"],
["sphinx-build", "--builder", "man", "doc", "build/sphinx/html"],
]