From 2ce72b40cb2310ba1dd1c4b8aae671aeb9720acc Mon Sep 17 00:00:00 2001 From: scriptautomate-bc <204508229+scriptautomate-bc@users.noreply.github.com> Date: Mon, 8 Jun 2026 23:16:19 -0500 Subject: [PATCH] Move to pydata theme for unification --- .devcontainer/Dockerfile | 4 +- README.rst | 2 +- docs/_templates/globaltoc.html | 104 ++++++++++++++++++++++++++++++ docs/_templates/header-links.html | 81 +++++++++++++++++++++++ docs/conf.py | 20 +++--- docs/index.rst | 2 +- docs/requirements.txt | 2 +- 7 files changed, 201 insertions(+), 14 deletions(-) create mode 100644 docs/_templates/globaltoc.html create mode 100644 docs/_templates/header-links.html diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index a7cd828..22200e9 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,6 +1,6 @@ -FROM bitnami/python:3.13 +FROM python:3.14 -RUN apt update && apt upgrade -y && apt install vim -y +RUN apt-get update && apt-get upgrade -y && apt-get install vim -y # Add dev requirements ADD requirements.txt /tmp/ diff --git a/README.rst b/README.rst index 0a8d770..cffcc96 100644 --- a/README.rst +++ b/README.rst @@ -20,7 +20,7 @@ Salt User Guide If you're looking to learn about Salt, you've come to the right place. - `View the Sphinx-built documentation here `__ -- `View the source repo here `__ +- `View the source repo here `__ About the Salt User Guide ========================= diff --git a/docs/_templates/globaltoc.html b/docs/_templates/globaltoc.html new file mode 100644 index 0000000..7164405 --- /dev/null +++ b/docs/_templates/globaltoc.html @@ -0,0 +1,104 @@ +

{{ project|title }}

+
+{{ toctree(includehidden=True, collapse=False, maxdepth=1) }} +
+ + + + diff --git a/docs/_templates/header-links.html b/docs/_templates/header-links.html new file mode 100644 index 0000000..83c56c2 --- /dev/null +++ b/docs/_templates/header-links.html @@ -0,0 +1,81 @@ + + + + diff --git a/docs/conf.py b/docs/conf.py index e6895ca..295a9c0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -122,9 +122,8 @@ def setup(app): # a list of builtin themes. # -# Base Material Theme requirements html_show_sourcelink = True # False on private repos; True on public repos -html_theme = 'furo' +html_theme = 'pydata_sphinx_theme' html_title = project html_baseurl = 'https://docs.saltproject.io/salt/user-guide/' @@ -136,13 +135,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_teal.png", + "image_dark": "_static/img/SaltProject_altlogo_teal.png", }, + "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". @@ -155,10 +161,6 @@ def setup(app): 'css/local-testing.css' ] -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -html_logo = "_static/img/SaltProject_altlogo_teal.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/index.rst b/docs/index.rst index bdc980e..f2126e2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -39,6 +39,6 @@ Table of Contents :caption: Contribute topics/list-of-images - See a problem? Open an issue! + See a problem? Open an issue! Salt docs contributing guide GitLab repository diff --git a/docs/requirements.txt b/docs/requirements.txt index e3f3a08..628bbcc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ Sphinx-Substitution-Extensions>=2022.2.16 -furo>=2022.12.7 +pydata-sphinx-theme sphinx-copybutton>=0.5.1 sphinx-design>=0.3.0 sphinx-inline-tabs>=2022.1.2b11