From 4540102f0a2faec9e1fab4de1cd8ab35103acfcb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Michael=20Bla=C3=9F?= <michael.blass@uni-hamburg.de>
Date: Sat, 13 Mar 2021 06:38:49 +0100
Subject: [PATCH] updated docs build process for rtd.
---
.gitignore | 2 +-
.readthedocs.yml => .readthedocs.yaml | 7 ++--
docs/requirements.txt | 9 ++---
docs/source/api/apollon.aplot.rst | 7 ++++
docs/source/api/apollon.audio.rst | 7 ++++
docs/source/api/apollon.container.rst | 7 ++++
docs/source/api/apollon.datasets.rst | 7 ++++
docs/source/api/apollon.fractal.rst | 7 ++++
docs/source/api/apollon.hmm.poisson.rst | 7 ++++
docs/source/api/apollon.hmm.rst | 16 +++++++++
docs/source/api/apollon.hmm.utilities.rst | 7 ++++
docs/source/api/apollon.io.io.rst | 7 ++++
docs/source/api/apollon.io.json.rst | 7 ++++
docs/source/api/apollon.io.rst | 16 +++++++++
docs/source/api/apollon.onsets.rst | 7 ++++
docs/source/api/apollon.rst | 34 +++++++++++++++++++
docs/source/api/apollon.segment.rst | 7 ++++
docs/source/api/apollon.signal.container.rst | 7 ++++
.../api/apollon.signal.critical_bands.rst | 7 ++++
docs/source/api/apollon.signal.features.rst | 7 ++++
docs/source/api/apollon.signal.filter.rst | 7 ++++
docs/source/api/apollon.signal.rst | 20 +++++++++++
docs/source/api/apollon.signal.spectral.rst | 7 ++++
docs/source/api/apollon.signal.tools.rst | 7 ++++
docs/source/api/apollon.som.datasets.rst | 7 ++++
docs/source/api/apollon.som.defaults.rst | 7 ++++
docs/source/api/apollon.som.neighbors.rst | 7 ++++
docs/source/api/apollon.som.plot.rst | 7 ++++
docs/source/api/apollon.som.rst | 21 ++++++++++++
docs/source/api/apollon.som.som.rst | 7 ++++
docs/source/api/apollon.som.topologies.rst | 7 ++++
docs/source/api/apollon.som.utilities.rst | 7 ++++
docs/source/api/apollon.tools.rst | 7 ++++
docs/source/api/apollon.types.rst | 7 ++++
docs/source/api/modules.rst | 7 ++++
docs/source/conf.py | 2 +-
docs/source/index.rst | 2 +-
37 files changed, 304 insertions(+), 14 deletions(-)
rename .readthedocs.yml => .readthedocs.yaml (79%)
create mode 100644 docs/source/api/apollon.aplot.rst
create mode 100644 docs/source/api/apollon.audio.rst
create mode 100644 docs/source/api/apollon.container.rst
create mode 100644 docs/source/api/apollon.datasets.rst
create mode 100644 docs/source/api/apollon.fractal.rst
create mode 100644 docs/source/api/apollon.hmm.poisson.rst
create mode 100644 docs/source/api/apollon.hmm.rst
create mode 100644 docs/source/api/apollon.hmm.utilities.rst
create mode 100644 docs/source/api/apollon.io.io.rst
create mode 100644 docs/source/api/apollon.io.json.rst
create mode 100644 docs/source/api/apollon.io.rst
create mode 100644 docs/source/api/apollon.onsets.rst
create mode 100644 docs/source/api/apollon.rst
create mode 100644 docs/source/api/apollon.segment.rst
create mode 100644 docs/source/api/apollon.signal.container.rst
create mode 100644 docs/source/api/apollon.signal.critical_bands.rst
create mode 100644 docs/source/api/apollon.signal.features.rst
create mode 100644 docs/source/api/apollon.signal.filter.rst
create mode 100644 docs/source/api/apollon.signal.rst
create mode 100644 docs/source/api/apollon.signal.spectral.rst
create mode 100644 docs/source/api/apollon.signal.tools.rst
create mode 100644 docs/source/api/apollon.som.datasets.rst
create mode 100644 docs/source/api/apollon.som.defaults.rst
create mode 100644 docs/source/api/apollon.som.neighbors.rst
create mode 100644 docs/source/api/apollon.som.plot.rst
create mode 100644 docs/source/api/apollon.som.rst
create mode 100644 docs/source/api/apollon.som.som.rst
create mode 100644 docs/source/api/apollon.som.topologies.rst
create mode 100644 docs/source/api/apollon.som.utilities.rst
create mode 100644 docs/source/api/apollon.tools.rst
create mode 100644 docs/source/api/apollon.types.rst
create mode 100644 docs/source/api/modules.rst
diff --git a/.gitignore b/.gitignore
index 561eed3..35d2bc9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -68,7 +68,7 @@ instance/
.scrapy
# Sphinx documentation
-docs/_build/
+docs/source/_build/
# PyBuilder
target/
diff --git a/.readthedocs.yml b/.readthedocs.yaml
similarity index 79%
rename from .readthedocs.yml
rename to .readthedocs.yaml
index 50d940d..359acfa 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yaml
@@ -2,10 +2,8 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-# Required
version: 2
-# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: docs/source/conf.py
@@ -16,9 +14,8 @@ formats: all
# Optionally set the version of Python and requirements required to build your docs
python:
- version: 3.7
+ version: 3.9
install:
- requirements: docs/requirements.txt
- - method: pip
+ - method: setuptools
path: .
- system_packages: true
\ No newline at end of file
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 566c467..ccb88a3 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,6 +1,3 @@
-numpy
-scipy
-matplotlib
-soundfile
-sphinxcontrib_apidoc
-https://gitlab.rrz.uni-hamburg.de/bal7668/hmm/-/archive/master/hmm-master.zip
\ No newline at end of file
+Sphinx==3.5.1
+sphinx-rtd-theme==0.5.1
+sphinxcontrib-apidoc==0.3.0
diff --git a/docs/source/api/apollon.aplot.rst b/docs/source/api/apollon.aplot.rst
new file mode 100644
index 0000000..82e0150
--- /dev/null
+++ b/docs/source/api/apollon.aplot.rst
@@ -0,0 +1,7 @@
+apollon.aplot module
+====================
+
+.. automodule:: apollon.aplot
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.audio.rst b/docs/source/api/apollon.audio.rst
new file mode 100644
index 0000000..032df5f
--- /dev/null
+++ b/docs/source/api/apollon.audio.rst
@@ -0,0 +1,7 @@
+apollon.audio module
+====================
+
+.. automodule:: apollon.audio
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.container.rst b/docs/source/api/apollon.container.rst
new file mode 100644
index 0000000..29eb727
--- /dev/null
+++ b/docs/source/api/apollon.container.rst
@@ -0,0 +1,7 @@
+apollon.container module
+========================
+
+.. automodule:: apollon.container
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.datasets.rst b/docs/source/api/apollon.datasets.rst
new file mode 100644
index 0000000..d0a6041
--- /dev/null
+++ b/docs/source/api/apollon.datasets.rst
@@ -0,0 +1,7 @@
+apollon.datasets module
+=======================
+
+.. automodule:: apollon.datasets
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.fractal.rst b/docs/source/api/apollon.fractal.rst
new file mode 100644
index 0000000..013847a
--- /dev/null
+++ b/docs/source/api/apollon.fractal.rst
@@ -0,0 +1,7 @@
+apollon.fractal module
+======================
+
+.. automodule:: apollon.fractal
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.hmm.poisson.rst b/docs/source/api/apollon.hmm.poisson.rst
new file mode 100644
index 0000000..7831d9b
--- /dev/null
+++ b/docs/source/api/apollon.hmm.poisson.rst
@@ -0,0 +1,7 @@
+apollon.hmm.poisson module
+==========================
+
+.. automodule:: apollon.hmm.poisson
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.hmm.rst b/docs/source/api/apollon.hmm.rst
new file mode 100644
index 0000000..8829e76
--- /dev/null
+++ b/docs/source/api/apollon.hmm.rst
@@ -0,0 +1,16 @@
+apollon.hmm package
+===================
+
+.. automodule:: apollon.hmm
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ apollon.hmm.poisson
+ apollon.hmm.utilities
diff --git a/docs/source/api/apollon.hmm.utilities.rst b/docs/source/api/apollon.hmm.utilities.rst
new file mode 100644
index 0000000..6fd1d6b
--- /dev/null
+++ b/docs/source/api/apollon.hmm.utilities.rst
@@ -0,0 +1,7 @@
+apollon.hmm.utilities module
+============================
+
+.. automodule:: apollon.hmm.utilities
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.io.io.rst b/docs/source/api/apollon.io.io.rst
new file mode 100644
index 0000000..c2609f9
--- /dev/null
+++ b/docs/source/api/apollon.io.io.rst
@@ -0,0 +1,7 @@
+apollon.io.io module
+====================
+
+.. automodule:: apollon.io.io
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.io.json.rst b/docs/source/api/apollon.io.json.rst
new file mode 100644
index 0000000..287a240
--- /dev/null
+++ b/docs/source/api/apollon.io.json.rst
@@ -0,0 +1,7 @@
+apollon.io.json module
+======================
+
+.. automodule:: apollon.io.json
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.io.rst b/docs/source/api/apollon.io.rst
new file mode 100644
index 0000000..297d236
--- /dev/null
+++ b/docs/source/api/apollon.io.rst
@@ -0,0 +1,16 @@
+apollon.io package
+==================
+
+.. automodule:: apollon.io
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ apollon.io.io
+ apollon.io.json
diff --git a/docs/source/api/apollon.onsets.rst b/docs/source/api/apollon.onsets.rst
new file mode 100644
index 0000000..5f4a444
--- /dev/null
+++ b/docs/source/api/apollon.onsets.rst
@@ -0,0 +1,7 @@
+apollon.onsets module
+=====================
+
+.. automodule:: apollon.onsets
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.rst b/docs/source/api/apollon.rst
new file mode 100644
index 0000000..f445d6d
--- /dev/null
+++ b/docs/source/api/apollon.rst
@@ -0,0 +1,34 @@
+apollon package
+===============
+
+.. automodule:: apollon
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ apollon.hmm
+ apollon.io
+ apollon.signal
+ apollon.som
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ apollon.aplot
+ apollon.audio
+ apollon.container
+ apollon.datasets
+ apollon.fractal
+ apollon.onsets
+ apollon.segment
+ apollon.tools
+ apollon.types
diff --git a/docs/source/api/apollon.segment.rst b/docs/source/api/apollon.segment.rst
new file mode 100644
index 0000000..2bae755
--- /dev/null
+++ b/docs/source/api/apollon.segment.rst
@@ -0,0 +1,7 @@
+apollon.segment module
+======================
+
+.. automodule:: apollon.segment
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.signal.container.rst b/docs/source/api/apollon.signal.container.rst
new file mode 100644
index 0000000..9c6b0f3
--- /dev/null
+++ b/docs/source/api/apollon.signal.container.rst
@@ -0,0 +1,7 @@
+apollon.signal.container module
+===============================
+
+.. automodule:: apollon.signal.container
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.signal.critical_bands.rst b/docs/source/api/apollon.signal.critical_bands.rst
new file mode 100644
index 0000000..9f64c15
--- /dev/null
+++ b/docs/source/api/apollon.signal.critical_bands.rst
@@ -0,0 +1,7 @@
+apollon.signal.critical\_bands module
+=====================================
+
+.. automodule:: apollon.signal.critical_bands
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.signal.features.rst b/docs/source/api/apollon.signal.features.rst
new file mode 100644
index 0000000..d5e161b
--- /dev/null
+++ b/docs/source/api/apollon.signal.features.rst
@@ -0,0 +1,7 @@
+apollon.signal.features module
+==============================
+
+.. automodule:: apollon.signal.features
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.signal.filter.rst b/docs/source/api/apollon.signal.filter.rst
new file mode 100644
index 0000000..7b6f7fa
--- /dev/null
+++ b/docs/source/api/apollon.signal.filter.rst
@@ -0,0 +1,7 @@
+apollon.signal.filter module
+============================
+
+.. automodule:: apollon.signal.filter
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.signal.rst b/docs/source/api/apollon.signal.rst
new file mode 100644
index 0000000..5775529
--- /dev/null
+++ b/docs/source/api/apollon.signal.rst
@@ -0,0 +1,20 @@
+apollon.signal package
+======================
+
+.. automodule:: apollon.signal
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ apollon.signal.container
+ apollon.signal.critical_bands
+ apollon.signal.features
+ apollon.signal.filter
+ apollon.signal.spectral
+ apollon.signal.tools
diff --git a/docs/source/api/apollon.signal.spectral.rst b/docs/source/api/apollon.signal.spectral.rst
new file mode 100644
index 0000000..4dc66ef
--- /dev/null
+++ b/docs/source/api/apollon.signal.spectral.rst
@@ -0,0 +1,7 @@
+apollon.signal.spectral module
+==============================
+
+.. automodule:: apollon.signal.spectral
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.signal.tools.rst b/docs/source/api/apollon.signal.tools.rst
new file mode 100644
index 0000000..ba4471a
--- /dev/null
+++ b/docs/source/api/apollon.signal.tools.rst
@@ -0,0 +1,7 @@
+apollon.signal.tools module
+===========================
+
+.. automodule:: apollon.signal.tools
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.som.datasets.rst b/docs/source/api/apollon.som.datasets.rst
new file mode 100644
index 0000000..9fa46f2
--- /dev/null
+++ b/docs/source/api/apollon.som.datasets.rst
@@ -0,0 +1,7 @@
+apollon.som.datasets module
+===========================
+
+.. automodule:: apollon.som.datasets
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.som.defaults.rst b/docs/source/api/apollon.som.defaults.rst
new file mode 100644
index 0000000..f3a7b52
--- /dev/null
+++ b/docs/source/api/apollon.som.defaults.rst
@@ -0,0 +1,7 @@
+apollon.som.defaults module
+===========================
+
+.. automodule:: apollon.som.defaults
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.som.neighbors.rst b/docs/source/api/apollon.som.neighbors.rst
new file mode 100644
index 0000000..d658db3
--- /dev/null
+++ b/docs/source/api/apollon.som.neighbors.rst
@@ -0,0 +1,7 @@
+apollon.som.neighbors module
+============================
+
+.. automodule:: apollon.som.neighbors
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.som.plot.rst b/docs/source/api/apollon.som.plot.rst
new file mode 100644
index 0000000..08fcd8d
--- /dev/null
+++ b/docs/source/api/apollon.som.plot.rst
@@ -0,0 +1,7 @@
+apollon.som.plot module
+=======================
+
+.. automodule:: apollon.som.plot
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.som.rst b/docs/source/api/apollon.som.rst
new file mode 100644
index 0000000..5d31d06
--- /dev/null
+++ b/docs/source/api/apollon.som.rst
@@ -0,0 +1,21 @@
+apollon.som package
+===================
+
+.. automodule:: apollon.som
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ apollon.som.datasets
+ apollon.som.defaults
+ apollon.som.neighbors
+ apollon.som.plot
+ apollon.som.som
+ apollon.som.topologies
+ apollon.som.utilities
diff --git a/docs/source/api/apollon.som.som.rst b/docs/source/api/apollon.som.som.rst
new file mode 100644
index 0000000..492bf9a
--- /dev/null
+++ b/docs/source/api/apollon.som.som.rst
@@ -0,0 +1,7 @@
+apollon.som.som module
+======================
+
+.. automodule:: apollon.som.som
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.som.topologies.rst b/docs/source/api/apollon.som.topologies.rst
new file mode 100644
index 0000000..5385bb3
--- /dev/null
+++ b/docs/source/api/apollon.som.topologies.rst
@@ -0,0 +1,7 @@
+apollon.som.topologies module
+=============================
+
+.. automodule:: apollon.som.topologies
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.som.utilities.rst b/docs/source/api/apollon.som.utilities.rst
new file mode 100644
index 0000000..f8d0c2f
--- /dev/null
+++ b/docs/source/api/apollon.som.utilities.rst
@@ -0,0 +1,7 @@
+apollon.som.utilities module
+============================
+
+.. automodule:: apollon.som.utilities
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.tools.rst b/docs/source/api/apollon.tools.rst
new file mode 100644
index 0000000..45ef3e4
--- /dev/null
+++ b/docs/source/api/apollon.tools.rst
@@ -0,0 +1,7 @@
+apollon.tools module
+====================
+
+.. automodule:: apollon.tools
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/apollon.types.rst b/docs/source/api/apollon.types.rst
new file mode 100644
index 0000000..2ceb8dc
--- /dev/null
+++ b/docs/source/api/apollon.types.rst
@@ -0,0 +1,7 @@
+apollon.types module
+====================
+
+.. automodule:: apollon.types
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/modules.rst b/docs/source/api/modules.rst
new file mode 100644
index 0000000..52f8518
--- /dev/null
+++ b/docs/source/api/modules.rst
@@ -0,0 +1,7 @@
+apollon
+=======
+
+.. toctree::
+ :maxdepth: 4
+
+ apollon
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 01ae16b..61a6c46 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -63,7 +63,7 @@ html_static_path = ['_static']
# -- Options for apidoc -----------------------------------------------------
#
apidoc_module_dir = '../../src/apollon'
-apidoc_output_dir = 'reference'
+apidoc_output_dir = 'api'
apidoc_separate_modules = True
apidoc_module_first = True
apidoc_full = True
diff --git a/docs/source/index.rst b/docs/source/index.rst
index be63328..9a0cc7c 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -20,7 +20,7 @@ Contents
download
install
framework
- reference/modules
+ api/modules
* :ref:`genindex`
* :ref:`modindex`
--
GitLab