ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs ScyllaDB Sphinx Theme Upgrade guides Changelog

Caution

You're viewing documentation for a previous version of ScyllaDB Sphinx Theme. Switch to the latest stable version.

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.3.4 - 13 Dec 2022¶

Added¶

  • #646: The footer now adds a link to the community forum.

  • #651: The preference to keep the promotional banner closed now expires after 30 days.

Updated¶

  • #643: The “Edit this page” now opens default branch instead of the current branch of the docs you are viewing.

  • #647: Change “Scylla” occurrences to “ScyllaDB”.

  • #649: Remove the Scylla Cloud app from the header. Now the header only points to the Scylla Cloud docs.

1.3.3 - 29 Nov 2022¶

Added¶

  • #661: Maintainers can now add custom text after the content. This is useful for projects requiring a license notice on every documentation page.

Fixed¶

  • #624: Label roles are now hidden on the right sidebar.

1.3.2 - 28 Oct 2022¶

Added¶

  • #590: Create a new “label” role to differenciate between enterprise and open-source features.

  • #599: Zendesk verification tag.

Updated¶

  • #555: Now the multiversion extension is mantained on this repository.

  • dependabot: We’ve updated all the JavaScript and Python dependencies to the latest version.

Removed¶

  • [#556]: Removed the _utils/deploy.sh script. Now the logic to deploy the docs is in the GitHub Actions workflow.

1.3.1 - 19 Aug 2022¶

Added¶

  • #525: When a user clicks on Create an issue button, the issue is now created with the prefix docs: and the label documentation.

  • #531: Adds instructions to trigger pull requests previews with Amplify only when there are updates within the docs folder.

  • We added a quickstart guide to create your first documentation page, list it in the table of contents, and preview the site locally.

  • #551: Adds an option to hide the multiversion selector for projects for projects that only build one version.

Changed¶

  • #509: We redesigned the home page search box to make it more visible.

  • #515: Before, redirects were part of the theme. This means that, for every version, the same redirects were being created, giving us little control if we wanted to redirect a page from the previous version to a different URL. Now, we are using a separate third-party package to create redirections. Also, instead of creating the same redirections for each version, we generate them at the end once the docs are built. This allows us to have better control of the redirects per version.

  • #533: We improved the build time of docs previews by 80%.

  • #536: The multiversion version dropdown is now always displayed, even if there is only one version.

1.2.2 - 17 May 2022¶

Added¶

  • #472: The hero box directive now can display the search box with a new option.

  • #452: Various improvements on the search page UI.

Changed¶

  • #447: We’ve replaced Netlify for AWS Amplify to automatically build pull requests previews for docs.

Fixed¶

  • #406: Pages built with the make html builder were displaying an incorrect canonical URL.

1.2.1 - 29 March 2022¶

Added¶

  • #422: The theme generates a sitemap.xml by default.

Fixed¶

  • #421: Show always contribute buttons.

  • #425: CSS for the 404 page was not loading.

1.2 - 22 March 2022¶

IMPORTANT: For more information on how to update, see Migrating from 1.1 to 1.2.

Added¶

  • #379: We’ve added Netlify support to automatically build pull requests previews for docs. This feature is in beta for a reduced number of projects.

  • #390: Once a week, a GitHub Action finds for broken links in Markdown and restructuredText files. If there are broken links, the action will create a new issue in the same repository with the links that have to be fixed.

  • #401: We’ve added new warning messages when previewing a non-stable version of the documentation.

  • #402: Now, you can create landing pages with sidebars.

  • #402: The theme includes a GitHub Action that runs the theme tests automatically when some of the theme files are edited.

Changed¶

  • #359: We’ve updated all the JavaScript and Python dependencies to the latest version.

  • #361: Tables were redesigned to make them more readable.

  • #371: We’ve moved the contribute buttons to the right sidebar.

  • #372: The substitutions extension is now installed as a third-party dependency.

  • #403: The theme does not show the multiversion dropdown in the sidebar if there is only one item.

  • #404: Now, topic box images are hidden in responsive view.

  • #410: We’ve improved the search component load time.

Fixed¶

  • #357: The copy button displayed an empty circle on hover.

  • #362: The zoom option for images was only working with SVG images. Now, this feature is compatible with other formats such as PNG and JPG.

  • #382: When the top bar was closed, it continued appearing for milliseconds when the page was refreshed.

  • #389: We’ve increased the breadcrumbs spacing.

  • #406: Various pages shared the same canonical URL. Now, we point to the URL of the latest stable version of the document.

1.1.1 - 02 February 2022¶

Fixed¶

  • #344: Fixes the error TypeError: 'CQLLexer' object is not callable.

1.1 - 01 February 2022¶

IMPORTANT: For more information on how to update, see Migrating from 1.0 to 1.1.

Added¶

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

Changed¶

  • #263: Update JavaScript and Python dependencies to the latest version.

  • #307: Before, poetry was installed as a dependency. From this release, you must install Poetry as a prerequisite.

Fixed¶

  • #301: Tables with headings were not styled.

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

1.0.6 - 08 December 2021¶

Added¶

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

Changed¶

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

1.0.5 - 27 October 2021¶

Added¶

  • #213: We’ve added guides to help maintainers to migrate to ScyllaDB Sphinx Theme 1.0 and 1.1.

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

Changed¶

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

Fixed¶

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

1.0 - 01 September 2021¶

IMPORTANT: For more information on how to update, see Migrating from 0.x to 1.0.

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 ScyllaDB University live.

0.1.22 - 14 Apr 2021¶

Added¶

  • #152: Top-bar for ScyllaDB 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 ScyllaDB 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 ScyllaDB 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 ScyllaDB 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.

Was this page helpful?

PREVIOUS
Migrating from 0.x to 1.0
NEXT
Contribute
  • Create an issue
  • Edit this page

On this page

  • Changelog
    • 1.3.4 - 13 Dec 2022
      • Added
      • Updated
    • 1.3.3 - 29 Nov 2022
      • Added
      • Fixed
    • 1.3.2 - 28 Oct 2022
      • Added
      • Updated
      • Removed
    • 1.3.1 - 19 Aug 2022
      • Added
      • Changed
    • 1.2.2 - 17 May 2022
      • Added
      • Changed
      • Fixed
    • 1.2.1 - 29 March 2022
      • Added
      • Fixed
    • 1.2 - 22 March 2022
      • Added
      • Changed
      • Fixed
    • 1.1.1 - 02 February 2022
      • Fixed
    • 1.1 - 01 February 2022
      • Added
      • Changed
      • Fixed
    • 1.0.6 - 08 December 2021
      • Added
      • Changed
    • 1.0.5 - 27 October 2021
      • Added
      • Changed
      • Fixed
    • 1.0 - 01 September 2021
      • Added
      • Changed
      • Fixed
    • 0.1.25 - 05 July 2021
      • Fixed
    • 0.1.24 - 17 June 2021
      • Added
      • Fixed
      • Removed
    • 0.1.23 - 22 Apr 2021
      • Removed
    • 0.1.22 - 14 Apr 2021
      • Added
      • Fixed
    • 0.1.21 - 24 Jan 2021
      • Added
      • Changed
      • Removed
      • Fixed
    • 0.1.20 - 19 Jan 2021
      • Added
      • Changed
    • 0.1.19 - 07 Jan 2021
      • Added
      • Changed
      • Fixed
    • 0.1.18 - 31 Dec 2020
      • Added
    • 0.1.16 - 24 Nov 2020
      • Added
      • Changed
    • 0.1.15 - 17 Nov 2020
      • Added
    • 0.1.14 - 28 Oct 2020
      • Changed
    • 0.1.13 - 20 Oct 2020
      • Added
      • Changed
      • Fixed
      • Removed
    • 0.1.12 - 01 Oct 2020
      • Added
ScyllaDB Sphinx Theme
  • 1.3
    • 1.8
    • 1.7
    • 1.6
    • 1.5
    • 1.4
    • 1.3
    • 1.2
    • 1.1
  • Getting started
    • Toolchain
    • Installation
    • Quickstart
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirects support
    • Search support
    • Troubleshooting
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Labels
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • Migrating from 1.2 to 1.3
    • Migrating from 1.1 to 1.2
    • Migrating from 1.0 to 1.1
    • Migrating from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the theme
    • Source Code
Docs Tutorials University Contact Us About Us
© 2025 ScyllaDB | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 01 Apr 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6
Ask AI