Running and Contributing to Citus 11 Documentation Locally

Citus can use sharding across multiple computers to horizontally scale queries. Its query engine parallelizes incoming SQL queries, accelerating response times for large data sets, typically workloads near or exceeding 100 GB of data.

Horizontal scaling via sharding across many machines

Parallel execution of queries on those servers

Strong support for multi‑tenant applications, real‑time operational analytics, and high‑throughput transactional workloads

Citus 11 Documentation Official Repository

Clone the repository locally:

git clone https://github.com/citusdata/citus_docs/tree/v11.0-beta

Documentation Runtime Environment Setup

pyenv

A Python version‑management tool.

pyenv‑installer

Installs pyenv and related plugins such as virtualenv.

Example for macOS:

curl https://pyenv.run | bash

Install the required Python version

Read the version from runtime.txt: python-3.7.5 Install it:

pyenv install 3.7.5

Set up a virtual environment

# Switch to the required version
pyenv global 3.7.5

# Enter the docs directory and create a virtual environment
cd citus_docs
python -m venv .venv

# Activate the virtual environment
source .venv/bin/activate

Install requirements.txt

Inspect the file:

Sphinx==4.0.2
sphinx_rtd_theme_citus==0.5.25
docutils==0.16
sphinx-autobuild==0.7.1s

Note the addition of sphinx-autobuild.

Install the dependencies:

pip install -r requirements.txt

Run the documentation (watch mode)

make watch

Open http://127.0.0.1:8000 in a browser to view the generated documentation.