pgpainless/docs/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

* [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 diagrams from source requires `mermaid-cli` to be installed.
```shell
$ npm install -g @mermaid-js/mermaid-cli
```
Initial sphinx-based documentation 2022-07-06 23:56:41 +02:00			`# User Guide for PGPainless`

Add documentation about documentation to documentation readme heh 2022-07-08 17:45:58 +02:00			`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)`

Initial sphinx-based documentation 2022-07-06 23:56:41 +02:00			`## Build the Guide`

Add documentation about documentation to documentation readme heh 2022-07-08 17:45:58 +02:00			`To build:`

Initial sphinx-based documentation 2022-07-06 23:56:41 +02:00			```shell
			`$ make {html\|epub\|latexpdf}`
			```

Add documentation about documentation to documentation readme heh 2022-07-08 17:45:58 +02:00			Note: Building diagrams from source requires `mermaid-cli` to be installed.
Initial sphinx-based documentation 2022-07-06 23:56:41 +02:00			```shell
Add documentation about documentation to documentation readme heh 2022-07-08 17:45:58 +02:00			`$ npm install -g @mermaid-js/mermaid-cli`
Initial sphinx-based documentation 2022-07-06 23:56:41 +02:00			```