jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix install broken link and add rst cheatsheet

Browse Source
This commit is contained in:
steve-chavez
2018-09-06 13:26:48 -05:00
parent 7845bdce8c
commit 02f7cba3d2
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -3
View File
@@ -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: 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 2. Clone this repository
4. Generate HTML 3. Generate HTML
```bash ```bash
cd postgrest-docs cd postgrest-docs
sphinx-build -b html -a -n . _build sphinx-build -b html -a -n . _build