Skip to content

Commit fad72c4

Browse files
authored
Enable readthedocs fail_on_warning (#111)
1 parent 5a72167 commit fad72c4

3 files changed

Lines changed: 4 additions & 54 deletions

File tree

.github/workflows/verify_sphinx_doc.yml

Lines changed: 0 additions & 53 deletions
This file was deleted.

.readthedocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ python:
2020
sphinx:
2121
builder: html
2222
configuration: docs/source/conf.py
23-
fail_on_warning: false
23+
fail_on_warning: true

docs/source/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434
author = "ITER Organization"
3535
src_host = "https://github.com/iterorganization/"
3636

37+
# Warn about missing references
38+
nitpicky = True
39+
3740
# Parse urls here for convenience, to be re-used
3841
# ITER docs
3942
iter_projects = "https://github.com/iterorganization/"

0 commit comments

Comments
 (0)