History

Paul Schaub 3030de7f3f Add further information about key protectors to documentation		2022-08-31 21:59:40 +02:00
..
source	Add further information about key protectors to documentation	2022-08-31 21:59:40 +02:00
Makefile	Initial sphinx-based documentation	2022-07-06 23:56:41 +02:00
README.md	Add documentation about documentation to documentation readme	2022-07-08 17:45:58 +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

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

To build:

$ make {html|epub|latexpdf}

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

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