ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

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

ScyllaDB Docs ScyllaDB Sphinx Theme Upgrade guides Migrating from 1.3 to 1.4

Migrating from 1.3 to 1.4¶

This guide explains how to upgrade the version of the ScyllaDB Sphinx Theme.

How to check your current theme version¶

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

../_images/version.png

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.

Was this page helpful?

PREVIOUS
Migrating from 1.4 to 1.5
NEXT
Migrating from 1.2 to 1.3
ScyllaDB Sphinx Theme
  • master
    • 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
  • 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.4 to 1.5
    • Migrating from 1.3 to 1.4
    • 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
  • Create an issue
  • Edit this page

On this page

  • Migrating from 1.3 to 1.4
    • How to check your current theme version
    • Upgrade to version 1.4
Logo
Docs University Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 22 Sep 2023.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.5.1