Reformat doc

Author: martaiborra

blosc2/SChunk.py

@@ -113,7 +113,7 @@ def append_data(self, data):
         """Append a data buffer to the SChunk.
 
         The data buffer must be of size `chunksize` specified in
-        :func:`__init__` .
+        :func:`SChunk.__init__ <blosc2.SChunk.SChunk.__init__>`.
 
         Parameters
         ----------

blosc2/__init__.py

@@ -85,7 +85,10 @@ class SplitMode(Enum):
 blosclib_version = "%s (%s)" % (VERSION_STRING, VERSION_DATE)
 
 # Internal Blosc threading
-nthreads = ncores = detect_number_of_cores() / 2
+ncores = detect_number_of_cores() / 2
+nthreads = ncores
+"""Number of threads to be used in compression/decompression.
+"""
 # Protection against too many threads
 if nthreads > 8:
     nthreads = 8
@@ -166,4 +169,5 @@ class SplitMode(Enum):
     "SChunk",
     "open",
     "remove_urlpath",
+    "nthreads"
 ]

blosc2/c-blosc2

@@ -409,7 +409,7 @@ def pack_array2(arr, chunksize=None, **kwargs):
     Other parameters
     ----------------
     kwargs: dict, optional
-        These are the same as the kwargs in :func:`~blosc2.SChunk.SChunk.__init__`.
+        These are the same as the kwargs in :func:`SChunk.__init__ <blosc2.SChunk.SChunk.__init__>`.
 
     Examples
     --------
@@ -526,7 +526,7 @@ def save_array(arr, urlpath, chunksize=None, **kwargs):
     Other parameters
     ----------------
     kwargs: dict, optional
-        These are the same as the kwargs in :func:`~blosc2.SChunk.SChunk.__init__`.
+        These are the same as the kwargs in :func:`SChunk.__init__ <blosc2.SChunk.SChunk.__init__>`.
 
     Examples
     --------
@@ -678,7 +678,7 @@ def set_nthreads(nthreads):
 
     See also
     --------
-    :func:`~blosc2.get_nthreads`
+    :attr:`~blosc2.nthreads`
     """
     blosc2.nthreads = nthreads
     return blosc2_ext.set_nthreads(nthreads)

blosc2/core.py

@@ -0,0 +1,18 @@
+blosc2.Codec
+============
+
+.. currentmodule:: blosc2
+
+.. autoclass:: Codec
+   
+   .. rubric:: Attributes
+
+   .. autosummary::
+   
+      ~Codec.BLOSCLZ
+      ~Codec.LZ4
+      ~Codec.LZ4HC
+      ~Codec.ZLIB
+      ~Codec.ZSTD
+   
+   

doc/reference/autofiles/top_level/blosc2.Codec.rst

@@ -0,0 +1,18 @@
+blosc2.Filter
+=============
+
+.. currentmodule:: blosc2
+
+.. autoclass:: Filter
+   
+   .. rubric:: Attributes
+
+   .. autosummary::
+   
+      ~Filter.NOFILTER
+      ~Filter.SHUFFLE
+      ~Filter.BITSHUFFLE
+      ~Filter.DELTA
+      ~Filter.TRUNC_PREC
+   
+   

doc/reference/autofiles/top_level/blosc2.Filter.rst

@@ -0,0 +1,17 @@
+blosc2.SplitMode
+================
+
+.. currentmodule:: blosc2
+
+.. autoclass:: SplitMode
+   
+   .. rubric:: Attributes
+
+   .. autosummary::
+   
+      ~SplitMode.ALWAYS_SPLIT
+      ~SplitMode.NEVER_SPLIT
+      ~SplitMode.AUTO_SPLIT
+      ~SplitMode.FORWARD_COMPAT_SPLIT
+   
+   

doc/reference/autofiles/top_level/blosc2.SplitMode.rst

@@ -0,0 +1,7 @@
+blosc2.nthreads
+===============
+
+.. currentmodule:: blosc2
+
+.. autodata:: nthreads
+   :no-value:

doc/reference/autofiles/top_level/blosc2.nthreads.rst

@@ -40,6 +40,7 @@ Set / Get compression params
     print_versions
     set_blocksize
     set_nthreads
+    nthreads
     set_releasegil
     set_compressor
     get_compressor