From 02f7cba3d2586f0e309af0b213634496825d6d1b Mon Sep 17 00:00:00 2001 From: steve-chavez Date: Thu, 6 Sep 2018 13:24:42 -0500 Subject: [PATCH] Fix install broken link and add rst cheatsheet --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bb9afe28e..4a2bb4f58 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -#### Sphinx source files for PostgREST documentation +# PostgREST documentation + +PostgREST docs use the reStructuredText format, check this [cheatsheet](https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst) to get acquainted with it. To generate HTML version: -1. Install Sphinx from the [sphinx website](http://sphinx-doc.org/latest/install.html) +1. Install Sphinx from the [sphinx website](http://www.sphinx-doc.org/en/stable/install.html) 2. Clone this repository -4. Generate HTML +3. Generate HTML ```bash cd postgrest-docs sphinx-build -b html -a -n . _build