- Documentation general updates

- Switched to Sphinx Book theme
This commit is contained in:
Ross Stewart
2025-08-29 15:19:05 +01:00
parent 70120d23cf
commit 11add0cd4e
4 changed files with 18 additions and 7 deletions

View File

@@ -1,18 +1,24 @@
{ {
"cSpell.words": [ "cSpell.words": [
"Alexa",
"asknavidrome", "asknavidrome",
"autoclass", "autoclass",
"automodule", "automodule",
"Brainz", "Brainz",
"favourite",
"maxdepth", "maxdepth",
"Navi", "Navi",
"Navidrome", "Navidrome",
"Navisonic", "Navisonic",
"quickstart", "quickstart",
"randomise",
"rosskouk",
"ssword", "ssword",
"toctree", "toctree",
"undoc", "undoc",
"Unstar" "unfavourite",
"Unstar",
"werkzeug"
], ],
"esbonio.sphinx.confDir": "", "esbonio.sphinx.confDir": "",
"files.associations": { "files.associations": {

View File

@@ -6,6 +6,6 @@ py-sonic
# Dev # Dev
sphinx sphinx
autodocsumm autodocsumm
groundwork-sphinx-theme
rinohtype rinohtype
flake8 flake8
sphinx-book-theme

View File

@@ -18,11 +18,11 @@ sys.path.insert(0, os.path.abspath('../skill'))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'AskNavidrome' project = 'AskNavidrome'
copyright = '2022, Ross Stewart' copyright = '2025, Ross Stewart'
author = 'Ross Stewart' author = 'Ross Stewart'
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = '0.1' release = '0.8'
# -- General configuration --------------------------------------------------- # -- 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 # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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, # 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, # relative to this directory. They are copied after the builtin static files,

View File

@@ -453,7 +453,7 @@ Code Documentation
****************** ******************
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
:caption: Contents: :caption: Contents:
AskNavidrome main AskNavidrome main