Skip to content

Commit 1dc98d3

Browse files
committed
Make sphinx-build free of warnings
Instruct sphinx to treat all warnings as errors in the CI build.
1 parent ce9501e commit 1dc98d3

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@
247247
# The name of an image file (within the static path) to use as favicon of the
248248
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
249249
# pixels large.
250-
html_favicon = "_static/favicon.ico"
250+
# html_favicon = "_static/favicon.ico"
251251

252252
# Add any paths that contain custom static files (such as style sheets) here,
253253
# relative to this directory. They are copied after the builtin static files,

envs/common/80_build_docs.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,6 @@ $PIP freeze
1818

1919
# Use the sphinx matching the venv we are in using SPHINXBUILD
2020
VENV_SPHINX_BUILD='../venv_imaspy/bin/sphinx-build'
21+
# Instruct sphinx to treat all warnings as errors
22+
export SPHINXOPTS='-W --keep-going'
2123
make -C docs html SPHINXBUILD="$PYTHON $VENV_SPHINX_BUILD"

0 commit comments

Comments
 (0)