PGPainless/pgpainless
PGPainless
/
pgpainless
mirror of https://github.com/pgpainless/pgpainless.git
1
0
Fork 0
Code Issues Releases Wiki Activity
pgpainless/docs
History
Paul Schaub 6f2b5ed1ca
Fix mermaid-cli cmd 		2022-07-08 00:21:40 +02:00
..
source Fix mermaid-cli cmd 2022-07-08 00:21:40 +02:00
Makefile 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
make.bat Initial sphinx-based documentation 2022-07-06 23:56:41 +02:00
requirements.txt Add .readthedocs.yaml 2022-07-07 00:44:28 +02:00

README.md

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