More cross-references and low_level -> top_level

Author: FrancescAlted

blosc2/core.py

@@ -613,6 +613,11 @@ def set_compressor(codec):
     -----
     The `compname` parameter in python-blosc API has been replaced by :paramref:`codec` , using `compname`
     as parameter or a string as a :paramref:`codec` value will not work.
+
+    See also
+    --------
+    :func:`~blosc2.get_compressor`
+    :func:`~blosc2.compressor_list`
     """
     return blosc2_ext.set_compressor(codec)
 
@@ -670,19 +675,29 @@ def set_nthreads(nthreads):
     >>> oldn = blosc2.set_nthreads(2)
     >>> blosc2.set_nthreads(1)
     2
+
+    See also
+    --------
+    :func:`~blosc2.get_nthreads`
     """
     blosc2.nthreads = nthreads
     return blosc2_ext.set_nthreads(nthreads)
 
 
 def compressor_list():
     """
-    Returns a list of compressors available in C library.
+    Returns a list of compressors (codecs) available in C library.
 
     Returns
     -------
     out : list
-        The list of names.
+        The list of codec names.
+
+    See also
+    --------
+    :func:`~blosc2.get_compressor`
+    :func:`~blosc2.set_compressor`
+
     """
     return list(key.lower() for key in blosc2.Codec.__members__.keys())
 
@@ -749,6 +764,12 @@ def get_compressor():
     -------
     out : str
         The name of the compressor.
+
+    See also
+    --------
+    :func:`~blosc2.set_compressor`
+    :func:`~blosc2.compressor_list`
+
     """
     return blosc2_ext.get_compressor().decode()
 

doc/reference/index.rst

@@ -4,6 +4,6 @@ API Reference
 .. toctree::
     :maxdepth: 2
 
-    low_level
+    top_level
     schunk_api
     utils

doc/reference/low_level.rst doc/reference/top_level.rstdoc/reference/low_level.rst renamed to doc/reference/top_level.rst

@@ -1,4 +1,4 @@
-Low level API
+Top level API
 =============
 
 This API is meant to be compatible with the existing python-blosc API. There could be some parameters that are called differently, but other than that, they are largely compatible.
@@ -9,7 +9,7 @@ Compress and decompress
 -----------------------
 
 .. autosummary::
-   :toctree: autofiles/low_level/
+   :toctree: autofiles/top_level/
    :nosignatures:
 
    compress
@@ -29,7 +29,7 @@ Set / Get compression params
 ----------------------------
 
 .. autosummary::
-   :toctree: autofiles/low_level/
+   :toctree: autofiles/top_level/
    :nosignatures:
 
     clib_info
@@ -49,7 +49,7 @@ Enumerated classes
 ------------------
 
 .. autosummary::
-   :toctree: autofiles/low_level/
+   :toctree: autofiles/top_level/
    :nosignatures:
 
    Codec