Doc updates

d22d4c76 · Blaß, Michael · b85b1850 · d22d4c76 · d22d4c76 · d22d4c76
Commit d22d4c76 authored Mar 19, 2021 by Blaß, Michael
--- a/docs/source/api/apollon.signal.critical_bands.rst
+++ b/docs/source/api/apollon.signal.critical_bands.rst
--- a/docs/source/api/apollon.signal.features.rst
+++ b/docs/source/api/apollon.signal.features.rst
--- a/docs/source/api/apollon.signal.filter.rst
+++ b/docs/source/api/apollon.signal.filter.rst
--- a/docs/source/api/apollon.signal.rst
+++ b/docs/source/api/apollon.signal.rst
--- a/docs/source/api/apollon.signal.spectral.rst
+++ b/docs/source/api/apollon.signal.spectral.rst
--- a/docs/source/api/apollon.signal.tools.rst
+++ b/docs/source/api/apollon.signal.tools.rst
--- a/docs/source/api/apollon.som.datasets.rst
+++ b/docs/source/api/apollon.som.datasets.rst
--- a/docs/source/api/apollon.som.defaults.rst
+++ b/docs/source/api/apollon.som.defaults.rst
--- a/docs/source/api/apollon.som.neighbors.rst
+++ b/docs/source/api/apollon.som.neighbors.rst
--- a/docs/source/api/apollon.som.plot.rst
+++ b/docs/source/api/apollon.som.plot.rst
--- a/docs/source/api/apollon.som.rst
+++ b/docs/source/api/apollon.som.rst
--- a/docs/source/api/apollon.som.som.rst
+++ b/docs/source/api/apollon.som.som.rst
--- a/docs/source/api/apollon.som.topologies.rst
+++ b/docs/source/api/apollon.som.topologies.rst
--- a/docs/source/api/apollon.som.utilities.rst
+++ b/docs/source/api/apollon.som.utilities.rst
--- a/docs/source/api/apollon.tools.rst
+++ b/docs/source/api/apollon.tools.rst
--- a/docs/source/api/apollon.types.rst
+++ b/docs/source/api/apollon.types.rst
--- a/docs/source/api/modules.rst
+++ b/docs/source/api/modules.rst
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -5,9 +5,9 @@

 Welcome to the documentation of the apollon feature extraction framework!
 =========================================================================
-*apollon* is a feature extraction and modelling frame work for music data
+*apollon* is a feature extraction and modeling framework for music data
 analysis. It handles low-level audio feature extraction, their aggreagation
-using Hidden Markov models, and comparison by means of the Self-Organizing Map.
+using Hidden Markov models, and comparison by means of the self-organizing map.
 See the :doc:`framework` chapter for gentle introduction to the mentioned
 concepts.

@@ -20,7 +20,7 @@ Contents
   download
   install
   framework
-   api/modules
+   generated/api/modules

 * :ref:`genindex`
 * :ref:`modindex`
--- a/docs/source/install.rst
+++ b/docs/source/install.rst
@@ -2,8 +2,8 @@ Installation
 ***************************************
 apollon can be installed on GNU/Linux, macOS, and Windows. Installation process
 is similar on each of these plaforms. Note, however, that apollon contains
-Python C extension modules, which have to be compile locally for GNU/Linux and
-Windows users. If work on any of those platforms, please make shure that there
+CPython extension modules, which have to be compiled locally for GNU/Linux and
+Windows users. If you work on those platforms, please make shure that there
 is a C compiler set up on your machine; otherwise the installation will fail.
 In the case of macOS, a precompiled wheel is provided for the latest version
 only.
@@ -11,8 +11,8 @@ only.

 Install using pip
 =======================================
-The Python packager manager can automatically install download and install
-apollon from pip. Simply run the following command from your terminal:
+The Python packager manager can automatically download and install
+apollon from Pypi. Simply run the following command from your terminal:

 .. code-block:: Bash


--- a/src/apollon/__init__.py
+++ b/src/apollon/__init__.py
@@ -3,7 +3,7 @@
 # mblass@posteo.net

 """
-apollon/__init__.py -- Main package initialization.
+Apollon feature extraction framework.
 """

 import os as _os