From 11add0cd4e1fbce8f295792360af86cd6db1ee4d Mon Sep 17 00:00:00 2001 From: Ross Stewart Date: Fri, 29 Aug 2025 15:19:05 +0100 Subject: [PATCH] - Documentation general updates - Switched to Sphinx Book theme --- .vscode/settings.json | 8 +++++++- skill/requirements-full.txt | 4 ++-- sphinx/conf.py | 11 ++++++++--- sphinx/index.rst | 2 +- 4 files changed, 18 insertions(+), 7 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 2d3dc67..ddbd1a5 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,18 +1,24 @@ { "cSpell.words": [ + "Alexa", "asknavidrome", "autoclass", "automodule", "Brainz", + "favourite", "maxdepth", "Navi", "Navidrome", "Navisonic", "quickstart", + "randomise", + "rosskouk", "ssword", "toctree", "undoc", - "Unstar" + "unfavourite", + "Unstar", + "werkzeug" ], "esbonio.sphinx.confDir": "", "files.associations": { diff --git a/skill/requirements-full.txt b/skill/requirements-full.txt index 8d99752..048d6ed 100644 --- a/skill/requirements-full.txt +++ b/skill/requirements-full.txt @@ -6,6 +6,6 @@ py-sonic # Dev sphinx autodocsumm -groundwork-sphinx-theme rinohtype -flake8 \ No newline at end of file +flake8 +sphinx-book-theme \ No newline at end of file diff --git a/sphinx/conf.py b/sphinx/conf.py index acd636f..6d1e746 100644 --- a/sphinx/conf.py +++ b/sphinx/conf.py @@ -18,11 +18,11 @@ sys.path.insert(0, os.path.abspath('../skill')) # -- Project information ----------------------------------------------------- project = 'AskNavidrome' -copyright = '2022, Ross Stewart' +copyright = '2025, Ross Stewart' author = 'Ross Stewart' # The full version, including alpha/beta/rc tags -release = '0.1' +release = '0.8' # -- General configuration --------------------------------------------------- @@ -58,7 +58,12 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'groundwork' +html_theme = 'sphinx_book_theme' + +html_theme_options = { + "repository_url": "https://github.com/rosskouk/asknavidrome", + "use_repository_button": True +} # 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, diff --git a/sphinx/index.rst b/sphinx/index.rst index 2730300..b3c4688 100644 --- a/sphinx/index.rst +++ b/sphinx/index.rst @@ -453,7 +453,7 @@ Code Documentation ****************** .. toctree:: - :maxdepth: 1 + :maxdepth: 2 :caption: Contents: AskNavidrome main