Skip to content

Commit bd40678

Browse files
committed
Fix last remaining reference warnings
Enable nitpicky mode in CI to error on missing references.
1 parent 24d7a16 commit bd40678

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

ci/build_docs_and_dist.sh

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ pip install "`readlink -f dist/*.whl`[docs]"
3333
# Debugging:
3434
pip freeze
3535

36+
# Enable sphinx options:
37+
# - `-W`: turn warnings into errors
38+
# - `-n`: nit-picky mode, warn about all missing references
39+
# - `--keep-going`: with -W, keep going when getting warnings
40+
export SPHINXOPTS='-W -n --keep-going'
41+
3642
# Run sphinx to create the documentation
37-
export SPHINXOPTS='-W --keep-going' # Treat all warnings as errors
3843
make -C docs clean html

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,7 @@
416416
# "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
417417
"numpy": ("https://numpy.org/doc/stable", None),
418418
"scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
419+
"packaging": ("https://packaging.pypa.io/en/stable/", None),
419420
# "numba": ("https://numba.pydata.org/numba-doc/latest", None),
420421
# "matplotlib": ("https://matplotlib.org", None),
421422
# "xarray": ("http://xarray.pydata.org/en/stable/", None),

0 commit comments

Comments
 (0)