Skip to content

Commit

Permalink
ensure no warnings on docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
tkknight committed May 14, 2024
1 parent 0bd6351 commit 9cf0cbf
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 2 deletions.
5 changes: 4 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

# See https://www.sphinx-doc.org/en/master/man/sphinx-build.html?highlight=--keep-going#cmdoption-sphinx-build-W
WARNING_TO_ERROR = -W --keep-going

.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
Expand Down Expand Up @@ -55,7 +58,7 @@ clean:

.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
$(SPHINXBUILD) $(WARNING_TO_ERROR) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,6 @@

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
"python": ("https://docs.python.org/", None),
"python": ("https://docs.python.org/3/", None),
"iris": ("https://scitools-iris.readthedocs.io/en/stable/", None),
}
2 changes: 2 additions & 0 deletions docs/ref/release_notes.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _release_notes:

Release Notes
Expand Down

0 comments on commit 9cf0cbf

Please sign in to comment.