Changelog¶

#323: The theme includes a new directive to collapse long content and redundant information.

#300 : Support for Sphinx 4.x.

#263: We use dependabot to receive automatic notifications when there are new dependency updates.

#229: New file-wide metadata options.

#301: Tables with headings were not styled.

#309: Expertrec added a new component for projects in the search box page. We have re-styled the page to match the theme’s look and feel.

#187: When a reader clicks on an image that has been resized, this now opens in full width.

#193: We’ve added a button to hide the sidebar. With this feature, our readers can read the documentation with fewer distractions.

#206: We’ve updated jQuery dependency to 3.6.0.

#246: The contribute button is more noticeable.

#247: The sidebar’s dropdown icons sport a new design.

#245: The panel box component sports a new design.

#252: We’ve reviewed the warning that appears when the user is not reading the latest stable version of the documentation. Now, the warning also considers branches that are still under active development.

#259: The sidebar’s scrollbar is now thinner and in line with the new design.

#213: We’ve added guides to help Scylla developers to migrate to Scylla Sphinx Theme 1.0 and 1.1.

#236: Added documentation to install the toolchain for Windows users.

#214: Breadcrumbs now highlight the project’s name. With this change, readers will know which documentation site they are navigating.

#231: All external links include an external link icon, and they now open on a new page.

#240: We’ve removed transparency from the home page mascot.

#214: Breadcrumbs links to internal pages were not working.

#201: We’ve made a number of updates to the look and feel of the theme to improve the overall user experience.

#201: The static front end files (CSS, JS, and images) are now managed with webpack. For more information, see Contribute to the Theme.

#201: The promo banner now supports icons with the option theme option banner_icon_path. For more information, see Template Options.

#201: The contribute button adds the option “Edit on GitHub”. To configure your project to support this option, read Template Options.

#201: We run hooks on every commit to automatically point out linting issues.

#201: The new workflow docs-pr runs on pull requests to make sure docs build without warnings before being merged. For more information, see Deployment.

#201: Topics boxes (cards) can be used in other sections, and not just on the home page. We now have different layouts to suit most projects’ needs. Check them out at Topic Boxes

#201: We’ve added more unit tests to the project, especially to extensions.

#201: We’ve fixed JavaScript warnings and errors raised by the console.

#194: FontAwesome 5.0 backwards compatibility.

#180: Now projects can configure promotional banners.

#179: Troubleshooting guides for multiversion.

#173: Dropdown for Contributors with the options to “Report an Issue” and “Learn How to Contribute”.

#170: Option to hide versions from the multiversion dropdown.

#174: Shared substitutions for all projects.

#171: Branches name were rendered in ASC order.

#173: Report an issue button from footer.

#152: Top-bar for Scylla University live.

#152: Top-bar for Scylla University live.

#146: Guidelines for project maintainers.

#110: Theme option to override part of the version name in the multiversion dropdown.

#153: Create intermediate directories for redirections.

#121: smv_rename_latest_version setting in conf.py overrides the latest version output directory.

#121: Moved smv_latest_version from github/workflows/pages.yml to conf.py.

#121: _utils/redirects.sh script.

#121: make multiversionpreview was not redirecting automatically to the latest version.

#111: Show a warning if the latest version is not stable.

#106: Disable Scylla Summit banner (#106).

#108: Documentation of the project moved under docs folder.

#98: Show Sphinx & Theme version in the footer.

#100: Show the multiversion label when there is only one version.

#103: Report button does not break when the page title has inlines.

#84: Banner for Scylla Summit.

#95: Support for custom domain.

#92: Command to preview multiversion build.

#89: Rename the latest version URL automatically to stable.

#84: Banner for Scylla Summit.

#83: Copyright year in the footer is now updated automatically.

#78: Show a warning when the user is not reading not reading the latest version.

#72: Overwrite the Sphinx classification for external and internal links.

#71: Site description is now configurable per project.

#65: External links and download links are now followed by an icon.

#53: Now code blocks can include substitutions.

#64: The 404 page sports a new design.

#69: Redirections on multiversion builds were not working

#68: PIPX dependency.

#59: All projects now share a 404 page.

#58: Support for redirections.