PostgREST docs use the reStructuredText format, check this cheatsheet to get acquainted with it.
To generate HTML version:
- Install Sphinx from the sphinx website
- Clone this repository
- Generate HTML
cd postgrest-docs sphinx-build -b html -a -n . _build # open _build/index.html in your browser
If you use nix, you can just run:
nix-shell
This will build the docs and start a livereload server on http://localhost:5500
.
Sphinx Installation Notes:
- If you're on OSX you might want to install the Python from homebrew - then a simple
pip install sphinx
does the trick.