[feat] Convert the documentation to Read The Docs template

Following changes were made in this commit -
 - Sphinx's `conf.py` file was regenerated. Old configuration file is in `conf_old.py`
 - `custom.css` was added to set sidebar colors
 - `documentation.rst` page was added to serve as the home page for docs. Replaces the old `documentation.html`.
 - Some `rst` files were modified to reduce the number of sidebar pages

Signed-off-by: Anmol Mishra <anmolmishra1997@gmail.com>

Author: dhunstack

.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 nbformat gitpython
+          pip3 install sphinx pyparsing sphinxcontrib-doxylink docutils jupyter sphinx-toolbox nbformat gitpython sphinx-rtd-theme sphinx-copybutton
           # Install TensorFlow
           sudo sh src/3rdparty/tensorflow/setup_from_libtensorflow.sh
           # Install Gaia dependencies
@@ -44,9 +44,9 @@ jobs:
         run: |
           python3 waf doc
       - name: Upload built documentation
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: essentia-docs
           path: |
             doc/sphinxdoc/_build/html/*
-          if-no-files-found: error
+          if-no-files-found: error

doc/sphinxdoc/_static/css/custom.css

@@ -0,0 +1,25 @@
+div.wy-side-scroll {
+    background: #0b3954;
+}
+
+
+div.wy-side-nav-search {
+    background: #0b3954;
+}
+
+div.wy-side-nav-search .version {
+    color: rgba(255, 255, 255, 0.7);
+}
+
+div.wy-menu.wy-menu-vertical {
+    background: #0b3954;
+}
+
+
+span.caption-text {
+    color: #404040;
+}
+
+div.wy-menu .caption-text {
+    color: #C8152F;
+}

doc/sphinxdoc/algorithms_overview.rst

@@ -7,7 +7,7 @@ as well as a small description.
 
 Please note that this is not an exhaustive list but rather a quick overview of the most used
 algorithms in Essentia. For the full list of algorithms and their detailed documentation,
-please see the `complete reference <algorithms_reference.html>`_.
+please see the :doc:`complete reference <algorithms_reference>`.
 
 
 Audio input / output

doc/sphinxdoc/coding_guidelines.rst

@@ -1,7 +1,7 @@
 .. highlight:: cpp
 
-General development guidelines
-==============================
+Coding Guidelines
+=================
 
 Fixing bugs
 -----------
@@ -22,9 +22,6 @@ Doing commits in Github
   humorous in them, but messages such as "bsdjfh" are *not* allowed.
 
 
-Coding Guidelines
-=================
-
 Coding style guidelines
 -----------------------
 

doc/sphinxdoc/conf.py

@@ -17,251 +17,67 @@
 # You should have received a copy of the Affero GNU General Public License
 # version 3 along with this program. If not, see http://www.gnu.org/licenses/
 
+# Configuration file for the Sphinx documentation builder.
 
-#
-# Essentia documentation build configuration file, created by
-# sphinx-quickstart on Thu Nov 11 16:09:32 2010.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# 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.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# -- General configuration -----------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# -- Project information
 
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.viewcode',
-              'sphinxcontrib.doxylink',
-              # 'sphinxprettysearchresults',
-              'sphinx.ext.autosectionlabel',
-              'sphinx_toolbox.collapse']
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'contents'
-
-# General information about the project.
 project = u'Essentia'
-copyright = u'2006-2022, Universitat Pompeu Fabra'
+copyright = u'2006-2024, Universitat Pompeu Fabra'
+author = 'MTG'
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '2.1-beta6-dev'
-# The full version, including alpha/beta/rc tags.
 release = '2.1-beta6-dev'
+version = '2.1-beta6-dev'
+root_doc = 'documentation'
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
+# -- General configuration
 
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+extensions = [
+    'sphinx.ext.viewcode',
+    'sphinxcontrib.doxylink',
+    'sphinx.ext.autosectionlabel',
+    'sphinx_toolbox.collapse',
+    'sphinx_copybutton',
+    ]
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
+# -- Options for HTML output
+templates_path = ['_templates']
 exclude_patterns = ['_build']
 
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'friendly'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output ---------------------------------------------------
-
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'sphinxdoc_mtg'
-
-# If true, the text around the keyword is shown as summary of each search result.
-# Default is True.
-html_show_search_summary = False
-
-# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = ['_templates']
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
+#
+html_theme = "sphinx_rtd_theme"
 html_theme_options = {
-    "nosidebar": "false",
+    'logo_only': True,
 }
 
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-#html_logo = 'mtg_logo.png'
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-html_favicon = 'favicon.ico'
-
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+html_static_path = ["_static"]
+html_css_files = [
+    "css/custom.css",
+]
+html_logo = "_static/essentia_logo.svg"
+html_favicon = '_static/favicon.ico'
 
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
+# -- Options for EPUB output
+epub_show_urls = 'footnote'
 
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = { 'index': [ 'indexsidebar.html', 'searchbox.html' ] }
-#html_sidebars = { '**': [] } # disable sidebar on all pages
-
-# We only want a sidebar on the models page.
-html_sidebars = {
-    # 'index': [],
-    '**': [],
-    'algorithms_reference': ['localtoc.html'],
-    'models': ['localtoc.html'],
-}
+# Sidebar templates
+# html_sidebars = {
+#     '**': []
+# }
 
 # 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',
-                         'applications': 'applications.html',
-                         'documentation': 'documentation.html'}
-
-# 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
-
-# If false, no index is generated.
-html_use_index = False
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'Essentiadoc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-#latex_documents = [
-#  ('index', 'Essentia.tex', u'Essentia Documentation',
-#   u'Nicolas Wack', 'manual'),
-#]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-#man_pages = [
-#    ('index', 'essentia', u'Essentia Documentation',
-#     [u'Nicolas Wack'], 1)
-#]
+html_additional_pages = {
+                        #  'index': 'index.html',
+                        #  'applications': 'applications.html',
+                        #  'documentation': 'documentation.html',
+                         }
 
+# html_extra_path = ['./_templates/index.html']
 
 doxylink = {
     'essentia': ('EssentiaDoxygen.tag', 'doxygen')