Skip to content
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

Jump to bottom

Use PyData theme for docs #485

Merged
merged 3 commits into from
Oct 28, 2023
Merged

Use PyData theme for docs #485

merged 3 commits into from
Oct 28, 2023

Conversation

jakirkham
Copy link
Member

@jakirkham jakirkham commented Oct 27, 2023 •
edited
Loading

Make use of the PyData theme in the docs.

Previously RTD installed and configured the default html_theme to use sphinx-rtd-theme, which was ok. However RTD recently changed this as explained in this blogpost. As a result, the docs started using the Sphinx default.

Taking this opportunity to more closely align the Numcodecs docs with the Zarr docs, which use the PyData theme ( zarr-developers/zarr-python#1242 ). This should have a more seamless experience for the reader.

TODO:

  • Unit tests and/or doctests in docstrings
  • Tests pass locally
  • Docstrings and API docs for any new/modified user-facing classes and functions
  • Changes documented in docs/release.rst
  • Docs build locally
  • GitHub Actions CI passes
  • Test coverage to 100% (Codecov passes)

@jakirkham jakirkham enabled auto-merge (squash) October 28, 2023 02:29
@jakirkham jakirkham merged commit 45a8ef3 into zarr-developers:main Oct 28, 2023
24 checks passed
@jakirkham jakirkham deleted the use_pydata_theme branch October 28, 2023 03:31
@joshmoore joshmoore mentioned this pull request Oct 31, 2023
Closed
7 tasks
QuLogic added a commit to QuLogic/numcodecs that referenced this pull request Jul 21, 2024
@QuLogic
Remove Sphinx pinning
5d1151a 
This was pinned in zarr-developers#434 because of the RTD theme, but zarr-developers#485 switched to
the pydata sphinx theme, so there should not be any issues.

Fixes zarr-developers#435
@QuLogic QuLogic mentioned this pull request Jul 21, 2024
Merged
6 tasks
QuLogic added a commit to QuLogic/numcodecs that referenced this pull request Jul 21, 2024
@QuLogic
Remove Sphinx pinning
94c2bf1 
This was pinned in zarr-developers#434 because of the RTD theme, but zarr-developers#485 switched to
the pydata sphinx theme, so there should not be any issues.

Fixes zarr-developers#435
QuLogic added a commit to QuLogic/numcodecs that referenced this pull request Jul 21, 2024
@QuLogic
Remove Sphinx pinning
189d0cf 
This was pinned in zarr-developers#434 because of the RTD theme, but zarr-developers#485 switched to
the pydata sphinx theme, so there should not be any issues.

Fixes zarr-developers#435
DimitriPapadopoulos pushed a commit to DimitriPapadopoulos/numcodecs that referenced this pull request Aug 10, 2024
@jakirkham @DimitriPapadopoulos
Use PyData theme for docs (zarr-developers#485)
bacc126 
* Require `pydata-sphinx-theme` in `docs`

* Configure `pydata_sphinx_theme` in docs

* Note PyData theme change
dstansby pushed a commit that referenced this pull request Aug 11, 2024
@QuLogic
Remove Sphinx pinning (#552)
8b53fc1 
This was pinned in #434 because of the RTD theme, but #485 switched to
the pydata sphinx theme, so there should not be any issues.

Fixes #435
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@jakirkham