postgrest

T

Joe NelsonandGitHub e7ddea0acf Document long jwt secrets as required (#109 )

* Use long jwt secrets as required

* Fix spelling and adjust custom dictionary

2017-10-07 13:03:30 -05: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

Exp claim must be an int, not a string

2017-08-20 14:15:59 -05: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

Document long jwt secrets as required (#109 )

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

auth.rst

Document long jwt secrets as required (#109 )

2017-10-07 13:03: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

Tutorial 1

2017-07-04 22:28:17 -05:00

install.rst

Document long jwt secrets as required (#109 )

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

intro.rst

Document long jwt secrets as required (#109 )

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

Makefile

Sphinx quickstart

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

postgrest.dict

Document long jwt secrets as required (#109 )

2017-10-07 13:03:30 -05: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.