Skip to content

Commit c6688a7

Browse files
committed
Treat mkdocs warnings as errors
Otherwise wrong cross-references and other errors go mostly unnoticed. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 08ddf2a commit c6688a7

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

cookiecutter/{{cookiecutter.github_repo_name}}/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ repo_url: "https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.github_
1111
# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
1212
# if the project uses a different default branch.
1313
edit_uri: "edit/main/docs/"
14+
strict: true # Treat warnings as errors
1415

1516
# Build directories
1617
theme:

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH"
99
repo_name: "frequenz-repo-config-python"
1010
repo_url: "https://github.com/frequenz-floss/frequenz-repo-config-python"
1111
edit_uri: "edit/main/docs/"
12+
strict: true # Treat warnings as errors
1213

1314
# Build directories
1415
theme:

0 commit comments

Comments
 (0)