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 223cf009fc
Fix User-ID format in documentation and note invalid user-id formats in tests 		2022-07-12 10:33:43 +02:00
..
source Fix User-ID format in documentation and note invalid user-id formats in tests 2022-07-12 10:33:43 +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

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

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