Skip to content

Conversation

@dstansby
Copy link
Contributor

In #1918 I noticed that errors on the doc build are not failing the readthedocs build. This is because sphinx runs hatch run docs:rtd, which in turn runs sphinx-build with no options, which does not fail on warnings.

Instead I think it's better to let readthedocs manage calling sphinx itself, and manage dependencies itself too for caching reasons. This allows it to use the configuration options that we define in the Makefile, which is the only way to configure sphinx to error on warnings.

I also updated the hatch run docs:build script to use make html, so it also catches sphinx warnings and turn them into errors.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@jhamman jhamman merged commit 67d521e into zarr-developers:v3 Jun 1, 2024
@dstansby dstansby deleted the rtd-sphinx branch June 1, 2024 16:43
d-v-b pushed a commit to d-v-b/zarr-python that referenced this pull request Jun 4, 2024
* Run sphinx directly on readthedocs

* Update doc build script
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants