From f759b8bfc6b7d15f4432bc7fd318d6fdaf2b376b Mon Sep 17 00:00:00 2001 From: Erwan Thomas Date: Sun, 18 Aug 2019 23:32:08 +0200 Subject: [PATCH] Fix miscellaneous Sphinx warnings (#244) * /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. --- admin.rst | 2 +- index.rst | 1 + install.rst | 5 +++-- tutorials/tut1.rst | 4 +++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/admin.rst b/admin.rst index f8bfd1a95..12af107e4 100644 --- a/admin.rst +++ b/admin.rst @@ -272,7 +272,7 @@ As discussed in :ref:`singular_plural`, there are no special URL forms for singu .. code:: http - GET /people?id=eq.1 + GET /people?id=eq.1 HTTP/1.1 Accept: application/vnd.pgrst.object+json This allows compound primary keys and makes the intent for singular response independent of a URL convention. diff --git a/index.rst b/index.rst index 0b45f8713..5c8a34dad 100644 --- a/index.rst +++ b/index.rst @@ -21,6 +21,7 @@ :target: https://www.paypal.me/postgrest | + PostgREST is a standalone web server that turns your PostgreSQL database directly into a RESTful API. The structural constraints and permissions in the database determine the API endpoints and operations. Sponsors diff --git a/install.rst b/install.rst index ebc0ea979..807b87c78 100644 --- a/install.rst +++ b/install.rst @@ -297,10 +297,11 @@ The database connection string above is just an example. Adjust the role and pas .. code-block:: bash listen_addresses = 'localhost,10.0.0.10' + You might also need to add a new IPv4 local connection within pg_hba.conf. For instance: - + .. code-block:: bash - + host all all 10.0.0.10/32 trust Containerized PostgREST *and* db with docker-compose diff --git a/tutorials/tut1.rst b/tutorials/tut1.rst index bcef5e632..71c288d11 100644 --- a/tutorials/tut1.rst +++ b/tutorials/tut1.rst @@ -151,9 +151,11 @@ Go back to jwt.io and change the payload to { "role": "todo_user", - "exp": + "exp": 123456789 } +**NOTE**: Don't forget to change the dummy epoch value :code:`123456789` in the snippet above to the epoch value returned by the psql command. + Copy the updated token as before, and save it as a new environment variable. .. code-block:: bash