Fail doc build on warnings (#1548)

* Fail doc build on warnings

* Add fail on warning to readthedocs

* Disable navigation with keys in docs

* Add release note

---------

Co-authored-by: Josh Moore <josh@openmicroscopy.org>

Author: dstansby

.readthedocs.yaml

@@ -7,6 +7,7 @@ build:
 
 sphinx:
   configuration: docs/conf.py
+  fail_on_warning: true
 
 python:
   install:

docs/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+SPHINXOPTS    = -W --keep-going
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build

docs/conf.py

@@ -144,6 +144,7 @@
         },
     ],
     "collapse_navigation": True,
+    "navigation_with_keys": False,
 }
 
 # Add any paths that contain custom themes here, relative to this directory.

docs/index.rst

@@ -60,6 +60,7 @@ Zarr is a file storage format for chunked, compressed, N-dimensional arrays base
         +++
 
         .. button-ref:: tutorial
+            :ref-type: ref
             :expand:
             :color: dark
             :click-parent:

docs/release.rst

@@ -21,6 +21,9 @@ Unreleased
 Docs
 ~~~~
 
+* The documentation build now fails if there are any warnings.
+  By :user:`David Stansby <dstansby>` :issue:`1548`.
+
 * Add links to ``numcodecs`` docs in the tutorial.
   By :user:`David Stansby <dstansby>` :issue:`1535`.
 
@@ -169,10 +172,12 @@ Major changes
 
 * Improve Zarr V3 support, adding partial store read/write and storage transformers.
   Add new features from the `v3 spec <https://zarr-specs.readthedocs.io/en/latest/core/v3.0.html>`_:
+
     * storage transformers
     * `get_partial_values` and `set_partial_values`
     * efficient `get_partial_values` implementation for `FSStoreV3`
     * sharding storage transformer
+
   By :user:`Jonathan Striebel <jstriebel>`; :issue:`1096`, :issue:`1111`.
 
 * N5 nows supports Blosc.