Mod: Update dev requirements and documentation.

Labbeti · Jan 5, 2024 · 4dc7879 · 4dc7879
1 parent 081bac1
commit 4dc7879
Show file tree

Hide file tree

Showing 16 changed files with 74 additions and 47 deletions.
diff --git a/docs/aac_datasets.datasets.functional.audiocaps.rst b/docs/aac_datasets.datasets.functional.audiocaps.rst
@@ -0,0 +1,7 @@
+aac\_datasets.datasets.functional.audiocaps module
+==================================================
+
+.. automodule:: aac_datasets.datasets.functional.audiocaps
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_datasets.datasets.functional.clotho.rst b/docs/aac_datasets.datasets.functional.clotho.rst
@@ -0,0 +1,7 @@
+aac\_datasets.datasets.functional.clotho module
+===============================================
+
+.. automodule:: aac_datasets.datasets.functional.clotho
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_datasets.datasets.functional.common.rst b/docs/aac_datasets.datasets.functional.common.rst
@@ -0,0 +1,7 @@
+aac\_datasets.datasets.functional.common module
+===============================================
+
+.. automodule:: aac_datasets.datasets.functional.common
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_datasets.datasets.functional.macs.rst b/docs/aac_datasets.datasets.functional.macs.rst
@@ -0,0 +1,7 @@
+aac\_datasets.datasets.functional.macs module
+=============================================
+
+.. automodule:: aac_datasets.datasets.functional.macs
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_datasets.datasets.functional.rst b/docs/aac_datasets.datasets.functional.rst
@@ -0,0 +1,19 @@
+aac\_datasets.datasets.functional package
+=========================================
+
+.. automodule:: aac_datasets.datasets.functional
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   aac_datasets.datasets.functional.audiocaps
+   aac_datasets.datasets.functional.clotho
+   aac_datasets.datasets.functional.common
+   aac_datasets.datasets.functional.macs
+   aac_datasets.datasets.functional.wavcaps
diff --git a/docs/aac_datasets.datasets.functional.wavcaps.rst b/docs/aac_datasets.datasets.functional.wavcaps.rst
@@ -0,0 +1,7 @@
+aac\_datasets.datasets.functional.wavcaps module
+================================================
+
+.. automodule:: aac_datasets.datasets.functional.wavcaps
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_datasets.datasets.legacy.audiocaps.rst b/docs/aac_datasets.datasets.legacy.audiocaps.rst
diff --git a/docs/aac_datasets.datasets.legacy.clotho.rst b/docs/aac_datasets.datasets.legacy.clotho.rst
diff --git a/docs/aac_datasets.datasets.legacy.macs.rst b/docs/aac_datasets.datasets.legacy.macs.rst
diff --git a/docs/aac_datasets.datasets.legacy.rst b/docs/aac_datasets.datasets.legacy.rst
diff --git a/docs/aac_datasets.datasets.rst b/docs/aac_datasets.datasets.rst
@@ -12,7 +12,7 @@ Subpackages
 .. toctree::
    :maxdepth: 4
 
-   aac_datasets.datasets.legacy
+   aac_datasets.datasets.functional
 
 Submodules
 ----------

diff --git a/docs/aac_datasets.utils.audioset_mapping.rst b/docs/aac_datasets.utils.audioset_mapping.rst
@@ -0,0 +1,7 @@
+aac\_datasets.utils.audioset\_mapping module
+============================================
+
+.. automodule:: aac_datasets.utils.audioset_mapping
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_datasets.utils.globals.rst b/docs/aac_datasets.utils.globals.rst
@@ -0,0 +1,7 @@
+aac\_datasets.utils.globals module
+==================================
+
+.. automodule:: aac_datasets.utils.globals
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_datasets.utils.paths.rst b/docs/aac_datasets.utils.paths.rst
diff --git a/docs/aac_datasets.utils.rst b/docs/aac_datasets.utils.rst
@@ -12,7 +12,9 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
+   aac_datasets.utils.audioset_mapping
+   aac_datasets.utils.cmdline
    aac_datasets.utils.collate
    aac_datasets.utils.collections
    aac_datasets.utils.download
-   aac_datasets.utils.paths
+   aac_datasets.utils.globals
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -6,3 +6,5 @@ click==8.0.4
 black==22.10.0
 ipykernel==6.9.1
 twine==4.0.1
+sphinx==7.2.6
+sphinx-press-theme==0.8.0