Sphinx ScyllaDB Theme 1.0 is now released 🥳
Learn more
Menu

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.0 - 01 September 2021

Added

  • #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.

Changed

  • #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

Fixed

  • #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.

0.1.25 - 05 July 2021

Fixed

  • #194: FontAwesome 5.0 backwards compatibility.

0.1.24 - 17 June 2021

Added

  • #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.

Fixed

  • #171: Branches name were rendered in ASC order.

Removed

  • #173: Report an issue button from footer.

0.1.23 - 22 Apr 2021

Removed

  • #152: Top-bar for Scylla University live.

0.1.22 - 14 Apr 2021

Added

  • #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.

Fixed

  • #153: Create intermediate directories for redirections.

0.1.21 - 24 Jan 2021

Added

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

Changed

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

Removed

  • #121: _utils/redirects.sh script.

Fixed

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

0.1.20 - 19 Jan 2021

Added

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

Changed

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

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

0.1.19 - 07 Jan 2021

Added

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

Changed

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

Fixed

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

0.1.18 - 31 Dec 2020

Added

  • #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.

0.1.16 - 24 Nov 2020

Added

  • #84: Banner for Scylla Summit.

Changed

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

0.1.15 - 17 Nov 2020

Added

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

0.1.14 - 28 Oct 2020

Changed

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

  • #71: Site description is now configurable per project.

0.1.13 - 20 Oct 2020

Added

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

  • #53: Now code blocks can include substitutions.

Changed

  • #64: The 404 page sports a new design.

Fixed

  • #69: Redirections on multiversion builds were not working

Removed

  • #68: PIPX dependency.

0.1.12 - 01 Oct 2020

Added

  • #59: All projects now share a 404 page.

  • #58: Support for redirections.