citus_docs icon indicating copy to clipboard operation
citus_docs copied to clipboard

Documentation for Citus. Distributed PostgreSQL as an extension.

Sphinx source files for Citus documentation

To generate HTML version:

  1. Install Sphinx from the sphinx website
  2. Clone this repository
  3. Install Sphinx theme
    pip install sphinx_rtd_theme_citus
    
  4. Generate HTML
    cd citus_docs
    make
    
    # open _build/index.html in your browser
    

Sphinx Installation Note: on OS X it's better to install sphinx via pip rather than Homebrew. (The brew formula is keg-only and used primarily by other tools.) Use pip install sphinx.