Skip to content

Fail doc build on warnings #1548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 31, 2023
Merged

Fail doc build on warnings #1548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c82c3a2
Fail doc build on warnings
dstansby Oct 25, 2023
4397944
Add fail on warning to readthedocs
dstansby Oct 25, 2023
3d6043b
Disable navigation with keys in docs
dstansby Oct 31, 2023
0e0bec9
Add release note
dstansby Oct 31, 2023
36773ed
Merge branch 'main' into doc-warnings
joshmoore Oct 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ build:

sphinx:
configuration: docs/conf.py
fail_on_warning: true

python:
install:
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXOPTS = -W --keep-going
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@
},
],
"collapse_navigation": True,
"navigation_with_keys": False,
}

# Add any paths that contain custom themes here, relative to this directory.
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 5 additions & 0 deletions docs/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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.
Expand Down