postgrest

T

How to pass a single json object to stored proc

List HTTP codes for db errors

Point out 404 semantics of singular responses

OR query workaround

Include nginx example for singular rewrite

2017-03-25 22:57:27 -07:00

_static

Custom CSS

2016-11-25 15:01:52 -08:00

erd

First draft of resource embedding

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

.gitignore

Sphinx quickstart

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

admin.rst

Misc improvements

2017-03-25 22:57:27 -07:00

api.rst

Misc improvements

2017-03-25 22:57:27 -07:00

auth.rst

replace code:postgres by code:sql (#43 )

2017-02-20 14:33:37 -08:00

circle.yml

Spell check, WIP Circle CI for sphinx

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

conf.py

Bump copyright year

2017-02-03 16:14:41 -08:00

index.rst

Override document title for index.rst (#34 )

2017-02-02 08:02:43 -08:00

install.rst

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.