forked from Github-Mirrors/canaille
doc: make CI fail if the documentation generation raise warnings
This commit is contained in:
parent
c2101f91da
commit
650391891a
4 changed files with 3 additions and 4 deletions
2
.github/workflows/tests.yaml
vendored
2
.github/workflows/tests.yaml
vendored
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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),
|
||||
|
|
|
@ -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"],
|
||||
]
|
||||
|
||||
|
|
Loading…
Reference in a new issue