ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs ScyllaDB Sphinx Theme Upgrade guides Upgrading from 1.6 to 1.7

Upgrading from 1.6 to 1.7¶

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

Upgrade to version 1.7¶

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

  1. To ensure documentation builds when backporting content to previous branches, update the .github/workflows/gh-pages.yml workflow file as outlined below:

    # (...)
    on:
      push:
        branches:
          - master # Replace with your default branch name
          - 'branch-**' # Use the versioned branch pattern
        paths:
          - "docs/**"
      workflow_dispatch:
    
    jobs:
      build:
        runs-on: ubuntu-latest
        steps:
          - name: Checkout
            uses: actions/checkout@v4
            with:
              ref: ${{ github.event.repository.default_branch }}
              persist-credentials: false
              fetch-depth: 0
          - name: Set up Python
            uses: actions/setup-python@v5
            with:
              python-version: '3.10'
    # (...)
    
    
  2. The theme no longer supports Amplify. If your project includes the .github/actions/amplify-enhanced directory, the .github/workflows/docs-amplify-enhanced.yml workflow, or an amplify.yml file, consider removing them and move to the new approach. For more information, see Pull requests previews.

Was this page helpful?

PREVIOUS
Upgrading from 1.7 to 1.8
NEXT
Upgrading from 1.5 to 1.6
  • Create an issue
  • Edit this page

On this page

  • Upgrading from 1.6 to 1.7
    • How to check your current theme version
    • Upgrade to version 1.7
ScyllaDB Sphinx Theme
  • 1.8
    • 1.8
    • 1.7
    • 1.6
    • 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
    • AI chatbot support (beta)
    • Search support
    • Dependabot support
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
    • Centralized publication
  • Examples
    • Admonitions
    • Alert
    • Collapse
    • Code blocks
    • Diagrams
    • Glossary
    • Headings
    • Hero box
    • Icons
    • Images
    • Includes
    • Labels
    • Links
    • Lists
    • Mascots
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Tooltips
    • Topic box
    • Versions
  • Upgrade guides
    • Upgrading from 1.7 to 1.8
    • Upgrading from 1.6 to 1.7
    • Upgrading from 1.5 to 1.6
    • Upgrading from 1.4 to 1.5
    • Upgrading from 1.3 to 1.4
    • Upgrading from 1.2 to 1.3
    • Upgrading from 1.1 to 1.2
    • Upgrading from 1.0 to 1.1
    • Upgrading from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the theme
    • Source Code
Docs Tutorials University Contact Us About Us
© 2025 ScyllaDB | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 09 May 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6
Ask AI