Migrating from 1.4 to 1.5¶

How to check your current theme version¶

The theme version is displayed in the footer of the project’s documentation site.

If your project theme’s version is >=1.4, follow this guide to get the latest version.

Upgrade to version 1.5¶

Here are the main breaking changes between the 1.4 and 1.5 versions.

1. Update the following Python dependencies in docs/pyproject.toml:

   sphinx-scylladb-theme = "~1.5.1"
   pygments = "2.15.1"
   sphinx-sitemap = "2.5.0"
   

2. In the conf.py file, update the options for the sitemap extension as follows:

   # -- Options for sitemap extension ---------------------------------------
   
   sitemap_url_scheme = "/stable/{link}"
   

   Note that the sitemap_url_scheme must start with a slash.

3. Within the same conf.py file, edit the HTML theme options to enable the newly introduced feature for collecting user feedback:

   html_theme_options = {
       "hide_feedback_buttons": 'false',
   }
   

4. Build the docs locally:

   cd docs
   make preview
   

5. Review and address any warnings that may arise in the terminal during the build process.