Erwan ThomasandSteve Chávez
f759b8bfc6
* /index.rst:24: WARNING: Line block ends without a blank line. * /install.rst:300: WARNING: Explicit markup ends without a blank line; unexpected unindent. * /admin.rst:273: WARNING: Could not lex literal_block as "http". Highlighting skipped. * /tutorials/tut1.rst:150: WARNING: Could not lex literal_block as "json". Highlighting skipped. * Remove extra newline * Use integer value as epoch in JSON snippet Even though using a string value is convenient (due to the lack of JSON comments), it is confusing since the value should actually be an integer. A slightly more verbose documentation is therefore preferable.
PostgREST documentation http://postgrest.org/
PostgREST docs use the reStructuredText format, check this cheatsheet to get acquainted with it.
You can use pipenv to build the docs locally:
pipenv install
pipenv run python livereload_docs.py
Or if you use nix, you can just run:
nix-shell
Both of these options will build the docs and start a livereload server on http://localhost:5500.
Translations
Translations are maintained in separate repositories forked from this one. Once you finish translating in your fork you can upload the project to https://readthedocs.org and we'll link to it in the official documentation site https://postgrest.org.
See more details in the chinese translation PR.
Available translations
- Chinese - https://github.com/Lellansin/postgrest-docs (latest version
v0.4.2.0)