Contributing to Citus

June 6, 2023 ยท View on GitHub

We're happy you want to contribute! You can help us in different ways:

  • Open an issue with suggestions for improvements
  • Fork this repository and submit a pull request

Before accepting any code contributions we ask that contributors sign a Contributor License Agreement (CLA). For an explanation of why we ask this as well as instructions for how to proceed, see the Microsoft CLA.

Building and previewing the docs locally

To generate an HTML version:

  1. Create a Python virtual environment and activate it.

    # in the citus_docs repo directory

python3.9 -m venv .venv
source .venv/bin/activate

    (The version of sphinx pinned by the project does not work with python 3.10+.)

  2. Install the Sphinx documentation system and the Citus theme:

    pip install -r requirements.txt

  3. Generate the HTML docs preview:

    make

# open _build/index.html in your browser

    Alternately, you can run a local development server to automatically rebuild a docs preview as you edit files.

    pip install sphinx-autobuild
make watch

# open http://127.0.0.1:8000 in your browser