pgpainless/docs/README.md

User Guide for PGPainless

Documentation for PGPainless is built from Markdown using Sphinx and MyST.

A built version of the documentation is available on http://pgpainless.rtfd.io/

Useful resources

• Sphix Documentation Generator
• MyST Markdown Syntax

Build the Guide

To build:

$ make {html|epub|latexpdf}

Note: Building diagrams from source requires mermaid-cli to be installed.

$ npm install -g @mermaid-js/mermaid-cli