mirror of https://github.com/pgpainless/pgpainless.git synced 2024-12-26 12:58:02 +01:00

History

Paul Schaub 16c44e670e Initial sphinx-based documentation		2022-07-06 23:56:41 +02:00
..
source	Initial sphinx-based documentation	2022-07-06 23:56:41 +02:00
make.bat	Initial sphinx-based documentation	2022-07-06 23:56:41 +02:00
Makefile	Initial sphinx-based documentation	2022-07-06 23:56:41 +02:00
package-lock.json	Initial sphinx-based documentation	2022-07-06 23:56:41 +02:00
package.json	Initial sphinx-based documentation	2022-07-06 23:56:41 +02:00
README.md	Initial sphinx-based documentation	2022-07-06 23:56:41 +02:00

User Guide for PGPainless

Build the Guide

$ make {html|epub|latexpdf}

Note: Building requires mermaid-cli to be installed in this directory:

$ # Move here
$ cd pgpainless/docs
$ npm install @mermaid-js/mermaid-cli

TODO: This is ugly. Install mermaid-cli globally? Perhaps point to user-installed mermaid-cli in conf.py's mermaid_cmd