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.

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

Docs: Update index.rst for installation and test changes #426

Merged

Conversation

psobolewskiPhD
Copy link
Contributor

Closes #425

This PR updates the instructions for installation and testing at:
https://numcodecs.readthedocs.io/en/stable/index.html

Specifically, it instructs to use pip and not python setup.py install and to use pytest and not nose.
I also changed the way the DISABLE flags are mentioned. I made the changes based on my attempts using arm64 macOS (so no AVX2, no SSE2). With pip install, setting the env flags wasn't needed, so I mention them as an extra note.

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)

@joshmoore
Copy link
Member

Workflows launched, cc: @jakirkham

@joshmoore
Copy link
Member

This now matches the other merged PRs. Merging but if there are any issues, we can update the mainline and the docs together. Once again, thanks, @psobolewskiPhD.

@joshmoore joshmoore merged commit f93cebd into zarr-developers:main Aug 3, 2023
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug (out-dated): Installation and test instructions on https://numcodecs.readthedocs.io
2 participants