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 Examples Links

LinksΒΆ

There are a few links you can use with different purposes.

Link type

Markup

Renders as

Description

External Link

`External Link <https://docs.scylladb.com/>`_

External Link

Use this markup to create a link to another site or project. When rendered it has an arrow pointing out icon. It opens the content in a new tab.

Internal Cross-reference

:ref:`Internal Link <here>`

Internal Link

This is an internal cross reference. It requires a bookmark. Content opens in the same tab.

Internal Cross-reference Bookmark

.. _here:

This is an internal cross reference bookmark. It requires an internal cross-reference anchor (above). It does not render, but serves as a point to link to.

Internal Cross-reference to Parameters

:ref:`Link to a config param <confprop_parameter_name>`

Renders the parameter name as a hyperlink.

This is an internal cross-reference to a parameter on the Configuration Parameters page. It does NOT require a bookmark, as parameter names on that are page implicit bookmarks. Content opens in the same tab. This option only applies to the scylladb/sylladb and scylladb/scylla-enterprise projects.

Internal Cross-reference to Parameter Gropus

:ref:`Link to a config param <confgroup_parameter_name>`

Renders the name of the parameter group as a hyperlink.

This is an internal cross-reference to a parameter group on the Configuration Parameters page. It does NOT require a bookmark, as group names on that are page implicit bookmarks. Content opens in the same tab. This option only applies to the scylladb/sylladb and scylladb/scylla-enterprise projects.

Internal Doc Reference

:doc:`Internal Doc <../index>`

Internal Doc

This is an internal doc cross reference. it looks for a file. A full path is required.

Download Link

:download:`download <index.rst>`

download

This opens a download window. It is used to help users download software or files.

Was this page helpful?

PREVIOUS
Labels
NEXT
Lists
  • Create an issue
  • Edit this page
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