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
ScyllaDB Docs ScyllaDB Sphinx Theme Upgrade guides Migrating from 1.4 to 1.5

Migrating from 1.4 to 1.5¶

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

Was this page helpful?

PREVIOUS
Upgrade guides
NEXT
Migrating from 1.3 to 1.4
ScyllaDB Sphinx Theme
  • 1.5
    • 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.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.4 to 1.5
    • How to check your current theme version
    • Upgrade to version 1.5
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