Add codec categories in doc contents#458
Merged
dstansby merged 14 commits intozarr-developers:mainfrom Sep 1, 2024
dstansby:doc-folders
Merged
Add codec categories in doc contents#458dstansby merged 14 commits intozarr-developers:mainfrom dstansby:doc-folders
dstansby merged 14 commits intozarr-developers:mainfrom
dstansby:doc-folders
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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 |
Contributor
Author
|
ping @zarrdevelopers, any chance someone could review this? |
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. |
Contributor
|
thanks @dstansby! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
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!