postgrest

T

Joe NelsonandGitHub e10599d065 Changes in 4.4 release (#121 )

* Updated full-text search

* Calling RPC with GET

* Customizing HTTP status codes and headers

* Move the admin section to bottom of TOC

* Revise JWT signing section of tutorial

* Selecting pkeys in embedding no longer required

2018-01-18 10:48:34 -06:00

_static

Note for windows users

2017-09-09 19:30:20 -05:00

erd

First draft of resource embedding

2016-11-21 23:04:06 -08:00

tutorials

Changes in 4.4 release (#121 )

2018-01-18 10:48:34 -06:00

.gitignore

Sphinx quickstart

2016-10-09 16:53:41 -07:00

admin.rst

Document long jwt secrets as required (#109 )

2017-10-07 13:03:30 -05:00

api.rst

Changes in 4.4 release (#121 )

2018-01-18 10:48:34 -06:00

auth.rst

Show how to use a JWK literal in the config file (#110 )

2017-10-07 19:59:30 -05:00

circle.yml

Spell check, WIP Circle CI for sphinx

2016-11-20 14:26:50 -08:00

conf.py

Move config section to install page

2017-09-09 20:21:46 -05:00

index.rst

Changes in 4.4 release (#121 )

2018-01-18 10:48:34 -06:00

install.rst

Add note that windows people need postgres on path (#117 )

2017-11-25 22:00:55 -06:00

intro.rst

Added Elyios as using PostgREST in production (#119 )

2017-12-27 21:56:04 -06:00

Makefile

Sphinx quickstart

2016-10-09 16:53:41 -07:00

postgrest.dict

Changes in 4.4 release (#121 )

2018-01-18 10:48:34 -06:00

README.md

Instructions for building docs locally

2017-02-27 09:38:21 -08:00

README.md

Sphinx source files for PostgREST documentation

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

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.
For an easier time refreshing your local preview of docs as you change it, try sphinx-autobuild.