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
12 changes: 12 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
API reference
=============

.. toctree::
:maxdepth: 2

compression/index
filter/index
other/index
checksum32
abc
registry
6 changes: 3 additions & 3 deletions docs/checksum32.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
32-bit checksums
================
Checksum codecs
===============
.. automodule:: numcodecs.checksum32

CRC32
Expand Down Expand Up @@ -37,7 +37,7 @@ JenkinsLookup3
--------------

.. autoclass:: JenkinsLookup3

.. autoattribute:: codec_id
.. autoattribute:: initval
.. autoattribute:: prefix
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions docs/compression/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Compression codecs
------------------

.. toctree::
:maxdepth: 2

blosc
bz2
gzip
lzma
lz4
pcodec
zfpy
zlib
zstd
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions docs/filter/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Filter codecs
-------------

.. toctree::
:maxdepth: 2

delta
fixedscaleoffset
quantize
bitround
packbits
categorize
astype
shuffle
File renamed without changes.
File renamed without changes.
File renamed without changes.
25 changes: 1 addition & 24 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,30 +64,7 @@ Contents
.. toctree::
:maxdepth: 2

abc
registry
blosc
pcodec
lz4
zfpy
zstd
zlib
gzip
bz2
lzma
delta
fixedscaleoffset
quantize
bitround
packbits
categorize
checksum32
astype
json
pickles
msgpacks
vlen
shuffle
api
release
contributing

Expand Down
11 changes: 11 additions & 0 deletions docs/other/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Other codecs
------------


.. toctree::
:maxdepth: 2

json
pickles
msgpacks
vlen
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ Enhancements
By :user:`Ryan Abernathey <rabernat>`, :issue:`501`.
* Use PyData theme for docs
By :user:`John Kirkham <jakirkham>`, :issue:`485`.
* Improve the structure of docs
By :user:`David Stansby <dstansby>`, :issue:`458`.

Fix
~~~
Expand Down