Doc updates

README.md

 # Apollon
-Apollon is a framework for modelling audio feature time series. It comprises
-* low-level audio feature extraction
-* Hidden-Markov Models
+Apollon is a Python framework for audio feature extraction and music similarity estimation. It 
+includes subpackages for
+
+* Audio feature extraction
+* Hidden Markov Models
 * Self-Organizing Map
 
 ## 1. Installation
+### 1.1 Install from PyPi
+The latest version of apollon is available on PyPi. 
 Download apollon or clone this repository. Navigate the package's root directory
 and install apollon using pip.
 ```

docs/Makefile

@@ -7,6 +7,9 @@ SPHINXBUILD   = sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = build
 
+clean:
+	rm -rf build/* source/api/*
+
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/conf.py

@@ -12,39 +12,48 @@ import sphinx_rtd_theme
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('./src/apollon/'))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'Apollon'
-copyright = '2019, Michael Blaß'
+project = 'apollon'
 author = 'Michael Blaß'
+copyright = '2019, Michael Blaß'
 
 # The full version, including alpha/beta/rc tags
+version = '0.1'
 release = '0.1.3'
-version = '0.1.3'
+
+master_doc = 'index'
 
 
 # -- General configuration ---------------------------------------------------
+source_suffix = {'.rst': 'restructuredtext'}
+language = 'en'
+#nitpicky = True
+numfig = True
+pygments_style = 'sphinx'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinxcontrib.apidoc',
+    'sphinx.ext.autosummary',
     'sphinx.ext.napoleon',
+    'sphinxcontrib.apidoc',
     'sphinx_rtd_theme']
 
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = ['_build', '.DS_Store']
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -60,10 +69,15 @@ html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
 
 
+# -- Options for autosummary ------------------------------------------------
+#
+
+
+
 # -- Options for apidoc -----------------------------------------------------
 #
 apidoc_module_dir = '../../src/apollon'
-apidoc_output_dir = 'api'
+apidoc_output_dir = 'generated/api'
 apidoc_separate_modules = True
 apidoc_module_first = True
 apidoc_full = True
@@ -73,7 +87,7 @@ apidoc_full = True
 #
 napoleon_google_docstring = True
 napoleon_numpy_docstring = False
-napoleon_include_init_with_doc = True
+napoleon_include_init_with_doc = False
 napoleon_include_private_with_doc = False
 napoleon_include_special_with_doc = False
 napoleon_use_ivar = True

docs/source/download.rst

+****************************************
 Download
-***************************************
-
+****************************************
 You can either download the source code from the `apollon GitHub repository`_
 or clone it directly with
 

docs/source/framework.rst

+****************************************
 Framework
-***************************************
+****************************************
+
+.. _fw-fe:
 
 Audio Feature Extraction
-=======================================
+========================================
 Extract some of the most common low-level audio feauters.
 
 
+.. _fw-hmm:
+
 Hidden Markov Model
-=======================================
+========================================
 Estimate Poisson-distributed Hidden Markov Models.
 
 
+.. _fw-som:
+
 Self-Organizing Map
-=======================================
+========================================
 Train some Self-organizing maps.