You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[DOCS] Salt Reference Docs: Sphinx Theme Refresh (Furo, Sphinx Book, or Alternative Third-Party Managed Theme) and Deprecation of saltstack2 custom theme
#67090
Open
ScriptAutomate opened this issue
Dec 6, 2024
· 0 comments
The saltstack2 Sphinx theme is fairly out-dated and in need of updates and better maintainership if wanting to continue to be used over time.
Suggested Fix
Salt Project should migrate to a new theme that is maintained by a larger community, such as Furo (which is currently used by Salt Install Guide, Salt User Guide, and many official Python projects throughout the Python community), or Sphinx Book Theme (which is maintained by ExecutableBooks, and may have missing features and expanded support that furo doesn't currently have).
If looking to Sphinx Book, should look at migrating the docs using Furo also over to the same theme, for a unified experience.
Description
The
saltstack2
Sphinx theme is fairly out-dated and in need of updates and better maintainership if wanting to continue to be used over time.Suggested Fix
Salt Project should migrate to a new theme that is maintained by a larger community, such as Furo (which is currently used by Salt Install Guide, Salt User Guide, and many official Python projects throughout the Python community), or Sphinx Book Theme (which is maintained by ExecutableBooks, and may have missing features and expanded support that
furo
doesn't currently have).If looking to Sphinx Book, should look at migrating the docs using Furo also over to the same theme, for a unified experience.
Type of documentation
Salt Project reference docs
Location or format of documentation
Source of reference docs theme in this repo:
doc/_themes/saltstack2
The published reference docs are found here:
The other published docs using
furo
can be found here:The text was updated successfully, but these errors were encountered: