Skip to content

Commit d42bac9

Browse files
dstansbydstansby
authored
Add codec categories in doc contents (#458)
* Add codec categories in doc contents * Improve contents structure * Put registry in API * Add release note * Move pcodec
1 parent a8f6efb commit d42bac9

28 files changed

+58
-27
lines changed

‎docs/api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
API reference
2+
=============
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
compression/index
8+
filter/index
9+
other/index
10+
checksum32
11+
abc
12+
registry

‎docs/checksum32.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
32-bit checksums
2-
================
1+
Checksum codecs
2+
===============
33
.. automodule:: numcodecs.checksum32
44

55
CRC32
@@ -37,7 +37,7 @@ JenkinsLookup3
3737
--------------
3838

3939
.. autoclass:: JenkinsLookup3
40-
40+
4141
.. autoattribute:: codec_id
4242
.. autoattribute:: initval
4343
.. autoattribute:: prefix

‎docs/blosc.rst renamed to ‎docs/compression/blosc.rst

File renamed without changes.

‎docs/bz2.rst renamed to ‎docs/compression/bz2.rst

File renamed without changes.

‎docs/gzip.rst renamed to ‎docs/compression/gzip.rst

File renamed without changes.

‎docs/compression/index.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Compression codecs
2+
------------------
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
blosc
8+
bz2
9+
gzip
10+
lzma
11+
lz4
12+
pcodec
13+
zfpy
14+
zlib
15+
zstd

‎docs/lz4.rst renamed to ‎docs/compression/lz4.rst

File renamed without changes.

‎docs/lzma.rst renamed to ‎docs/compression/lzma.rst

File renamed without changes.

‎docs/pcodec.rst renamed to ‎docs/compression/pcodec.rst

File renamed without changes.

‎docs/zfpy.rst renamed to ‎docs/compression/zfpy.rst

File renamed without changes.

0 commit comments

Comments
 (0)