ScyllaDB Docs ScyllaDB Sphinx Theme Contribute Contribute to the theme

Caution

You're viewing documentation for an unstable version of ScyllaDB Sphinx Theme. Switch to the latest stable version.

Contribute to the theme¶

If you are reading this guide because you have decided to contribute to the ScyllaDB Sphinx Theme, thank you! We appreciate your contribution and hope that this handbook will answer any questions you may have.

Configuring a Python environment¶

This project’s Python side is managed with uv. It combines several things in one tool:

Keeping track of Python dependencies, including ones required only for development and tests.
Initializing and managing a virtual environment.
Packaging the theme into a package for PyPI (Python Package Index). Such package can be installed with pip install and other tools.

To initialize a Python development environment for this project:

Make sure you have Python 3.11 or later installed (Python 3.12+ recommended).
Install uv.

Previewing the theme locally¶

The docs folder contains a sample project with the Sphinx theme already installed.

To preview the theme locally:

Open a new console prompt and clone the project.

git clone https://github.com/scylladb/sphinx-scylladb-theme.git

Build the docs.
```
cd docs
make preview
```
The previous command should generate a docs/_build/dirhtml directory. To preview the docs, open http://127.0.0.1:5500/ with your preferred browser.

Building the frontend¶

The frontend static files of this project are managed with webpack. It combines several things in one tool:

Installing third-party node modules.
Combining JavaScript and CSS in a single file.
Minifying CSS and JavaScript files.

The original static files are located under the folder src.

To build the minimized static files for this project:

Make sure you have Node.js 18 or later installed.
Build the static files with:

npm run build

This will create minified static files under the sphinx_scylladb_theme/static.

Running unit tests¶

Run:

uv run pytest tests

Publishing the theme to PyPi¶

Note

You need a PyPi account and be a project maintainer to release new theme versions.

To publish a new version of the theme to PyPi, run the following script:

./deploy.sh

To increase the minor version, run uv version --bump minor before ./deploy.

To increase the major version, run uv version --bump major before ./deploy.

Behind the scenes, deploy.sh executes the following logic:

Checks if the local git URL matches the original repository to prevent you from releasing from a personal fork.
Checks if the local contents differ from the remote master branch.
Increases the package’s version patch with the command uv version --bump patch.
Builds the package with the command uv build.
Publishes the package to PyPI with uv publish.

After publishing the package, you should see the new release listed on PyPI.

Was this page helpful?