Merge branch 'MTG:master' into master

.github/workflows/build-docs.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Fetch release tags from GitHub
@@ -22,7 +22,7 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y build-essential libeigen3-dev libyaml-dev libfftw3-dev libavcodec-dev libavformat-dev libavutil-dev libswresample-dev libsamplerate0-dev libtag1-dev libchromaprint-dev python3-dev python3-numpy-dev python3-numpy python3-yaml python3-six
           sudo apt-get install -y doxygen python3-pip pandoc
-          pip3 install sphinx pyparsing sphinxcontrib-doxylink docutils jupyter sphinx-toolbox
+          pip3 install sphinx pyparsing sphinxcontrib-doxylink docutils jupyter sphinx-toolbox nbformat gitpython sphinx-copybutton
           # Install TensorFlow
           sudo sh src/3rdparty/tensorflow/setup_from_libtensorflow.sh
           # Install Gaia dependencies
@@ -44,7 +44,7 @@ jobs:
         run: |
           python3 waf doc
       - name: Upload built documentation
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: essentia-docs
           path: |

.github/workflows/build-wheels.yml

@@ -32,7 +32,7 @@ jobs:
       PRE_CMD: ${{ matrix.PRE_CMD }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Fetch release tags from GitHub
@@ -51,7 +51,7 @@ jobs:
           ls wheelhouse/
           sudo python setup.py sdist
       - name: Upload wheels and sdist
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: essentia-python-wheels
           path: |

doc/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = Essentia
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.1-beta6-dev
+PROJECT_NUMBER  = 2.1-beta6-dev
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

doc/build_sphinx_doc.sh

@@ -1,5 +1,5 @@
 #!/bin/sh
-
+set -e
 
 # update Essentia version number in the Doxyfile
 cp doc/Doxyfile doc/Doxyfile.tmp
@@ -37,6 +37,7 @@ pandoc ../../FAQ.md -o FAQ.rst
 pandoc research_papers.md -o research_papers.rst
 jupyter nbconvert ../../src/examples/python/*.ipynb --to rst --output-dir .
 
+make clean
 make html
 
 # remove generated algorithm reference rst and temporary html files

doc/sphinxdoc/_templates/documentation.html

@@ -7,7 +7,7 @@ <h1>Essentia {{version}} Documentation</h1>
     <h2>What is Essentia?</h2>
 
     <p>Essentia is an open-source C++ library with Python and JavaScript bindings for <strong>audio analysis and audio-based music information retrieval</strong>. It is released
-    under the <strong><a href="http://tldrlegal.com/license/gnu-affero-general-public-license-v3-%28agpl-3.0%29#summary">Affero GPLv3
+    under the <strong><a href="https://www.tldrlegal.com/license/gnu-affero-general-public-license-v3-agpl-3-0">Affero GPLv3
     license</a></strong> and is also available under a proprietary license <a href="{{ pathto("licensing_information") }}">upon request</a>. The library contains an <strong><a href="{{ pathto("algorithms_overview") }}">
     extensive collection of reusable algorithms</a></strong> that implement audio input/output functionality, standard digital signal processing
     blocks, statistical characterization of data, and a large variety of spectral, temporal, tonal, and high-level music

doc/sphinxdoc/conf.py

@@ -167,19 +167,22 @@
 
 # We only want a sidebar on the models page.
 html_sidebars = {
+    # 'index': [],
     '**': [],
+    'algorithms_reference': ['localtoc.html'],
     'models': ['localtoc.html'],
 }
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 html_additional_pages = {'index': 'index.html',
-                         'algorithms_reference': 'algorithms_reference.html',
+                        #  'algorithms_reference': 'algorithms_reference.html',
                          'applications': 'applications.html',
                          'documentation': 'documentation.html'}
 
-exec(compile(open("essentia_reference.py").read(), "essentia_reference.py", 'exec'))
-html_additional_pages.update(essentia_algorithms)
+# Deprecating this. Generating algorithm docs directly from rst files is better for sidebar. 
+# exec(compile(open("essentia_reference.py").read(), "essentia_reference.py", 'exec'))
+# html_additional_pages.update(essentia_algorithms)
 
 # If false, no module index is generated.
 #html_domain_indices = True