PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2025-09-09 18:29:39 +02:00
Code Issues Releases Wiki Activity

Initial sphinx-based documentation

Browse source
This commit is contained in:
Paul Schaub 2022-07-06 23:56:41 +02:00
parent 762391659e
commit 16c44e670e
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
13 changed files with 3284 additions and 92 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/README.md Normal file
View file

@ -0,0 +1,16 @@
# User Guide for PGPainless
## Build the Guide
```shell
$ make {html|epub|latexpdf}
```
Note: Building requires `mermaid-cli` to be installed in this directory:
```shell
$ # 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