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 Configuration Redirects support

Redirects support¶

With ScyllaDB Sphinx Theme, you can define 301 redirects when moving or deleting a document.

By doing so, you will avoid broken links in other sites pointing to your documentation.

Redirects file¶

The redirects.yaml file is inside docs/_utils.

File structure¶

The redirects file has this structure:

# old_path: new_path

# redirection to internal link
/previous_path/page_a.html:/new_path/page_a.html

# redirection to external link
/previous_path/page_b:https://docs.scylladb.com/

Note

Do not add trailing paths / to define old paths.

Create a redirection¶

To create a redirection:

  1. Create a file redirects.yaml in docs/_utils if it does not exist.

  2. Add a new entry to the YAML file, assigning the old path in the left site operator and the new path on the right side.

    For example, to redirect to another internal page:

    /previous_path/page_a.html:/new_path/page_a.html
    

    Or, to redirect to an external URL:

    /previous_path/page_b.html:https://docs.scylladb.com/
    

Was this page helpful?

PREVIOUS
Markdown support
NEXT
AI chatbot support (beta)
  • Create an issue
  • Edit this page

On this page

  • Redirects support
    • Redirects file
    • File structure
    • Create a redirection
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