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 Commands

Commands¶

Use the command-line interface to run the following commands.

Prerequisites¶

To run the following commands, you will need to have installed Python +3.7 and PIP on your local environment.

Tip

If you are on Windows, see How to use the toolchain in Windows.

Preview current branch¶

The preview command builds a local instance of the docs site so you can view the rendering in a sandbox environment on your local browser.

To preview the docs:

  1. Build the docs.

cd docs
make preview
  1. Open http://127.0.0.1:5500/ with your preferred browser.

Tip

You can pass custom options to increase or decrease verbosity. For a list with all the available options, refer to the Sphinx documentation.

To increase verbosity, use the option -v:

make preview SPHINXOPTS=-v

To decrease verbosity, use the option -Q:

make preview SPHINXOPTS=-Q

Preview multiversion¶

The multiversionpreview command generates a local instance of the docs site with all specified versions available for navigation. You can view the rendering in a sandbox environment on your local browser. To preview multiple versions:

  1. Build the docs.

cd docs
make multiversionpreview
  1. Open http://0.0.0.0:5500/ with your preferred browser.

Build HTML for multiple versions¶

Note

The command make multiversion is aimed to be used by GitHub Actions CI. While documenting new features, it is not advised to run make multiversion, but make preview instead.

To generate multiple versions of the documentation:

  1. Build the docs.

cd docs
make multiversion
  1. The previous command should generate HTML docs under the docs/_build/dirhtml directory.

Tip

If the command raises an error, see Troubleshooting for help.

Clean all builds¶

The make preview operation creates content in the _build directory. When making changes to the docs, it is helpful to delete the contents of this directory before running make preview.

cd docs
make clean

Check for broken links¶

Check for broken links on the documentation site.

cd docs
make dirhtml
make linkcheck
PREVIOUS
Troubleshooting
NEXT
Deployment
ScyllaDB Sphinx Theme
  • 1.4
    • 1.4
    • 1.3
    • 1.2
    • 1.1
    • 1.0
  • 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.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

  • Commands
    • Prerequisites
    • Preview current branch
    • Preview multiversion
    • Build HTML for multiple versions
    • Clean all builds
    • Check for broken links
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 14 Mar 2023.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.4.1