essentia icon indicating copy to clipboard operation
essentia copied to clipboard

[feat] Convert the documentation to Read The Docs template

Open dhunstack opened this issue 1 year ago • 3 comments

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
Screenshot 2024-07-01 at 16 02 40 Screenshot 2024-07-01 at 16 05 43

dhunstack avatar Jul 01 '24 14:07 dhunstack

@dhunstack The build-docs workflows is missing sphinx_rtd_theme dependency (Theme error: no theme named 'sphinx_rtd_theme' found (missing theme.toml?)), it needs to be added here.

dbogdanov avatar Oct 17 '24 11:10 dbogdanov

Fixed doc build script to catch such issues in the future: https://github.com/MTG/essentia/commit/c896c90b452849a1acc5ff13c622bf9e128ad8a1.

dbogdanov avatar Oct 17 '24 11:10 dbogdanov

PR for dependency updates - https://github.com/MTG/essentia/pull/1444 Can merge that in master first to avoid creating another merge commit here.

dhunstack avatar Oct 17 '24 12:10 dhunstack