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

Add codec categories in doc contents #458

Merged
merged 14 commits into from
Sep 1, 2024

Conversation

dstansby
Copy link
Contributor

@dstansby dstansby commented Aug 24, 2023

This sorts the existing codecs into three sections within the docs table of contents: Compression, Filters, and Other. I often find it hard to distinguish between these as the docs are currently, so I'm hoping this makes the docs a bit easier to read.

This also greatly improves the contents structure of the docs, giving three top-level pages:

  1. API reference
  2. Release notes
  3. Contributing guide

Here's what the new API reference page looks like: https://numcodecs--458.org.readthedocs.build/en/458/api.html

I'm definitely not an expert in codecs, so I may have got some of the categories wrong!

Copy link

codecov bot commented Jul 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.91%. Comparing base (a8f6efb) to head (38e8f72).
Report is 69 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #458   +/-   ##
=======================================
  Coverage   99.91%   99.91%           
=======================================
  Files          59       59           
  Lines        2334     2334           
=======================================
  Hits         2332     2332           
  Misses          2        2           

@dstansby
Copy link
Contributor Author

ping @zarrdevelopers, any chance someone could review this?

@dstansby
Copy link
Contributor Author

Since this has been open for a year, and it's a month since I pinged for reviews I'm minded to merge it without a review since it's a big improvement to the docs and doesn't change any functionality. Unless anyone shouts in the next two weeks I will merge this.

@dstansby dstansby merged commit d42bac9 into zarr-developers:main Sep 1, 2024
26 checks passed
@dstansby dstansby deleted the doc-folders branch September 1, 2024 08:53
@d-v-b
Copy link
Contributor

d-v-b commented Sep 1, 2024

thanks @dstansby!

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