diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
index a7cd828..ae19143 100644
--- a/.devcontainer/Dockerfile
+++ b/.devcontainer/Dockerfile
@@ -1,4 +1,4 @@
-FROM bitnami/python:3.13
+FROM python:3.14
RUN apt update && apt upgrade -y && apt install vim -y
diff --git a/docs/_templates/globaltoc.html b/docs/_templates/globaltoc.html
new file mode 100644
index 0000000..1b136d2
--- /dev/null
+++ b/docs/_templates/globaltoc.html
@@ -0,0 +1,216 @@
+
+
+{{ toctree(includehidden=True, collapse=False, maxdepth=2) }}
+
+
+
+
+
diff --git a/docs/_templates/header-links.html b/docs/_templates/header-links.html
new file mode 100644
index 0000000..87caf05
--- /dev/null
+++ b/docs/_templates/header-links.html
@@ -0,0 +1,81 @@
+
+
+
+
diff --git a/docs/conf.py b/docs/conf.py
index 5ba4862..de74e71 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -118,7 +118,7 @@ def setup(app):
source_suffix = {".rst": "restructuredtext"}
# Add any paths that contain templates here, relative to this directory.
-# templates_path = ["_templates"]
+templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
@@ -138,11 +138,9 @@ def setup(app):
# a list of builtin themes.
#
-# Base Furo Theme requirements
-# More: https://pradyunsg.me/furo/customisation/
html_show_sourcelink = True # False on private repos; True on public repos
-html_theme = "furo"
-html_title = "Salt install guide"
+html_theme = "pydata_sphinx_theme"
+html_title = project
html_baseurl = "https://docs.saltproject.io/salt/install-guide/"
# Extends baseurl, in combination with version value
@@ -153,14 +151,20 @@ def setup(app):
"genindex.html",
]
+html_logo = None
html_theme_options = {
- "dark_css_variables": {
- "color-brand-primary": "#66CCF4",
- "color-brand-content": "#66CCF4",
+ "logo": {
+ "image_light": "_static/img/SaltProject_altlogo_blue.png",
+ "image_dark": "_static/img/SaltProject_altlogo_blue.png",
},
- # "announcement": 'IMPORTANT ANNOUNCEMENT: repo.saltproject.io has migrated to packages.broadcom.com!
Click here for migration FAQs (2024-11-22)',
+ "navbar_start": ["navbar-logo"],
+ "navbar_center": ["navbar-nav", "header-links"],
+ "navbar_end": ["theme-switcher", "navbar-icon-links"],
+ "navigation_depth": 4,
}
+html_sidebars = {"**": ["globaltoc.html"]}
+
# 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".
@@ -176,16 +180,6 @@ def setup(app):
copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-# For example, official Salt Project docs use images from the salt-branding-guide
-# https://gitlab.com/saltstack/open/salt-branding-guide/
-#
-# Example for >=4.0.0 of Sphinx (support for favicon via URL)
-# html_logo = "https://gitlab.com/saltstack/open/salt-branding-guide/-/raw/master/logos/SaltProject_altlogo_teal.png"
-# Example for <4.0.0 of Sphinx, if added into _static/img/ and html_static_path is valid
-html_logo = "_static/img/SaltProject_altlogo_blue.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. Favicons can be up to at least 228x228. PNG
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 0351271..b0d2b2f 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,4 +1,4 @@
-furo>=2024.8.6
+pydata-sphinx-theme>=0.18.0
sphinx-copybutton>=0.5.2
sphinx-design>=0.5.0
sphinx-inline-tabs>=2023.4.21