Fix audb.info docstring

audeering · Jan 23, 2024 · cd090db · cd090db
1 parent e1e74f3
commit cd090db
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 57 deletions.
diff --git a/audb/info/__init__.py b/audb/info/__init__.py
@@ -1,60 +1,3 @@
-r"""Get information from database headers.
-
-.. Specify repository to overwrite local config files
-.. jupyter-execute::
-    :hide-code:
-    :hide-output:
-
-    import audb
-
-    audb.config.REPOSITORIES = [
-        audb.Repository(
-            name='data-public',
-            host='https://audeering.jfrog.io/artifactory',
-            backend='artifactory',
-        )
-    ]
-
-.. Pre-load data without being verbose
-.. jupyter-execute::
-    :stderr:
-    :hide-code:
-    :hide-output:
-
-    audb.load(
-        'emodb',
-        version='1.4.1',
-        only_metadata=True,
-        verbose=False,
-    )
-
-Instead of caching the header (:file:`db.yaml`)
-of a database first locally to inspect it,
-the functions under :mod:`audb.info`
-provide you direct access to this information.
-
-So instead of running:
-
-.. jupyter-execute::
-
-    db = audb.load(
-        'emodb',
-        version='1.4.1',
-        only_metadata=True,
-        verbose=False,
-    )
-    db.tables
-
-You can run:
-
-.. jupyter-execute::
-
-    audb.info.tables(
-        'emodb',
-        version='1.4.1',
-    )
-
-"""
 from audb.core.info import attachments
 from audb.core.info import author
 from audb.core.info import bit_depths

diff --git a/docs/api-src/audb.info.rst b/docs/api-src/audb.info.rst
@@ -1,6 +1,64 @@
+.. Specify repository to overwrite local config files
+.. jupyter-execute::
+    :hide-code:
+    :hide-output:
+
+    import audb
+
+    audb.config.REPOSITORIES = [
+        audb.Repository(
+            name="data-public",
+            host="https://audeering.jfrog.io/artifactory",
+            backend="artifactory",
+        )
+    ]
+
+.. Pre-load data without being verbose
+.. jupyter-execute::
+    :stderr:
+    :hide-code:
+    :hide-output:
+
+    audb.load(
+        "emodb",
+        version="1.4.1",
+        only_metadata=True,
+        verbose=False,
+    )
+
+
 audb.info
 ==========
 
+Get information from database headers.
+
+Instead of caching the header (:file:`db.yaml`)
+of a database first locally to inspect it,
+the functions under :mod:`audb.info`
+provide you direct access to this information.
+
+So instead of running:
+
+.. jupyter-execute::
+
+    db = audb.load(
+        "emodb",
+        version="1.4.1",
+        only_metadata=True,
+        verbose=False,
+    )
+    db.tables
+
+You can run:
+
+.. jupyter-execute::
+
+    audb.info.tables(
+        "emodb",
+        version="1.4.1",
+    )
+
+
 .. automodule:: audb.info
 
 .. autosummary::