Migrating from 1.5 to 1.6¶

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.5, follow this guide to get the latest version.

Upgrade to version 1.6¶

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

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

   sphinx-scylladb-theme = "~1.6.1"
   pyyaml = "6.0.1"
   Sphinx = "7.2.6"
   sphinx-multiversion-scylla = "~0.3.1"
   sphinx-sitemap = "2.5.1"
   

2. Open docs/Makefile file and remove the following lines:

   # Windows variables
   ifeq ($(OS),Windows_NT)
       POETRY = $(APPDATA)\Python\Scripts\poetry
   endif
   

   Note

   If you are on Windows, ensure that Poetry is configured in your system’s PATH. For guidance on how to add Poetry to your PATH, refer to the Poetry documentation.

3. Build the docs locally:

   cd docs
   make preview
   

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