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

Add documentation about documentation to documentation readme

Browse source 
heh
This commit is contained in:
Paul Schaub 2022-07-08 17:45:58 +02:00
parent a131fe32aa
commit 7169b369b3
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
2 changed files with 14 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/README.md
View file

@ -1,16 +1,23 @@
# 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
* [Sphix Documentation Generator](https://www.sphinx-doc.org/en/master/)
* [MyST Markdown Syntax](https://myst-parser.readthedocs.io/en/latest/index.html)
## Build the Guide
To build:
```shell
$ make {html|epub|latexpdf}
```
Note: Building requires `mermaid-cli` to be installed in this directory:
Note: Building diagrams from source requires `mermaid-cli` to be installed.
```shell
$ # Move here
$ cd pgpainless/docs
$ npm install @mermaid-js/mermaid-cli
$ npm install -g @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