Skip to content

Migrate documentation to PyData Sphinx Theme#69185

Open
dwoz wants to merge 6 commits into
saltstack:3006.xfrom
dwoz:docs
Open

Migrate documentation to PyData Sphinx Theme#69185
dwoz wants to merge 6 commits into
saltstack:3006.xfrom
dwoz:docs

Conversation

@dwoz
Copy link
Copy Markdown
Contributor

@dwoz dwoz commented May 18, 2026

  • Update doc/conf.py to use pydata_sphinx_theme with custom navigation
  • Add custom top navigation bar with links to Install/User guides
  • Integrate native version switcher with doc/_static/versions.json
  • Apply referrerpolicy fix to embedded YouTube videos (Fixes Error 153)
  • Ensure persistent full navigation tree in the left sidebar
  • Add monkeypatch for theme's link shortener bug
docs_layout

- Update doc/conf.py to use pydata_sphinx_theme with custom navigation
- Add custom top navigation bar with links to Install/User guides
- Integrate native version switcher with doc/_static/versions.json
- Apply referrerpolicy fix to embedded YouTube videos (Fixes Error 153)
- Ensure persistent full navigation tree in the left sidebar
- Add monkeypatch for theme's link shortener bug
@dwoz
Copy link
Copy Markdown
Contributor Author

dwoz commented May 19, 2026

Removed the redundant salt label next to the saltproject logo

docs_layout_final

Daniel A. Wozniak added 4 commits May 19, 2026 00:23
- Move patch to the very top of doc/conf.py
- Add mechanism to patch already-imported references in sys.modules
- Ensure safe return value for malformed URLs to prevent crashes in all theme components
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

test:full Run the full test suite

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant