Migrating from 1.3 to 1.4¶

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

Upgrade to version 1.4¶

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

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

   sphinx-scylladb-theme = "~1.4.1"
   

2. Edit the docs/Makefile file and add the rm -f poetry.lock to the clean command:

   # Clean commands
   .PHONY: clean
   clean:
       rm -rf $(BUILDDIR)/*
       rm -f poetry.lock
   

3. Build the docs locally:

   cd docs
   make preview
   

4. Fix any warnings that appear in the terminal.