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

Update ReadTheDocs #383

Merged
merged 2 commits into from
Nov 3, 2022
Merged

Update ReadTheDocs #383

merged 2 commits into from
Nov 3, 2022

Conversation

jakirkham
Copy link
Member

Moves ReadTheDocs to the new configuration file 2 format.

TODO:

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

@jakirkham jakirkham requested a review from joshmoore November 3, 2022 06:44
@jakirkham jakirkham mentioned this pull request Nov 3, 2022
Merged
7 tasks
@jakirkham jakirkham changed the title Update RTD Update ReadTheDocs Nov 3, 2022
@jakirkham
Copy link
Member Author

@joshmoore could you please review this one?

joshmoore
joshmoore approved these changes Nov 3, 2022
View reviewed changes
Copy link
Member

@joshmoore joshmoore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The build in https://numcodecs--383.org.readthedocs.build/en/383/ looks fine. 👍 Merging.

(Reviewing this does make me realize, though, that we should migrate all of the changes from zarr-python here. cc: @MSanKeys963)

@joshmoore joshmoore merged commit c67683b into zarr-developers:main Nov 3, 2022
@jakirkham jakirkham deleted the update_rtd branch November 3, 2022 08:35
@jakirkham
Copy link
Member Author

Thanks Josh! 🙏

Yeah this is one of the things we did in zarr-python. Another was moving to pyproject.toml, which I have a PR ( #382 ) for.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshmoore joshmoore joshmoore approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jakirkham @joshmoore