Skip to content

Enable readthedocs fail_on_warning #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maarten-ic wants to merge 2 commits into
base: develop
Choose a base branch
from
+4 −54
Open

Enable readthedocs fail_on_warning #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
985dfc2
Enable readthedocs `fail_on_warning`
maarten-ic Mar 23, 2026
2011809
Set nitpicky mode in conf.py
maarten-ic Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 0 additions & 53 deletions .github/workflows/verify_sphinx_doc.yml
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ python:
sphinx:
builder: html
configuration: docs/source/conf.py
fail_on_warning: false
fail_on_warning: true
3 changes: 3 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@
author = "ITER Organization"
src_host = "https://github.com/iterorganization/"

# Warn about missing references
nitpicky = True

# Parse urls here for convenience, to be re-used
# ITER docs
iter_projects = "https://github.com/iterorganization/"
Expand Down
Loading