From 921492733ba539529ced1a8f82b0629f0af09f86 Mon Sep 17 00:00:00 2001 From: Benjamin Gandon Date: Sun, 12 Aug 2018 23:41:14 +0200 Subject: [PATCH] Fix reST syntax for fixed-with text --- CONTRIBUTING.rst | 4 ++-- README.rst | 18 +++++++++--------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ac76b77..eb86ba9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -63,9 +63,9 @@ If you are proposing a feature: Setting Up the Code for Local Development ----------------------------------------- -Here's how to set up `snappass` for local development. +Here's how to set up ``snappass`` for local development. -1. Fork the `snappass` repo on GitHub. +1. Fork the ``snappass`` repo on GitHub. 2. Clone your fork locally:: $ git clone git@github.com:your_name_here/snappass.git diff --git a/README.rst b/README.rst index af33790..dd551e4 100644 --- a/README.rst +++ b/README.rst @@ -68,29 +68,29 @@ Configuration You can configure the following via environment variables. -`SECRET_KEY` unique key that's used to sign key. This should +``SECRET_KEY``: unique key that's used to sign key. This should be kept secret. See the `Flask Documentation`__ for more information. .. __: http://flask.pocoo.org/docs/quickstart/#sessions -`DEBUG` to run Flask web server in debug mode. See the `Flask Documentation`__ for more information. +``DEBUG``: to run Flask web server in debug mode. See the `Flask Documentation`__ for more information. .. __: http://flask.pocoo.org/docs/quickstart/#debug-mode -`STATIC_URL` this should be the location of your static assets. You might not +``STATIC_URL``: this should be the location of your static assets. You might not need to change this. -`NO_SSL` if you are not using SSL. +``NO_SSL``: if you are not using SSL. -`REDIS_HOST` this should be set by Redis, but you can override it if you want. Defaults to `"localhost"` +``REDIS_HOST``: this should be set by Redis, but you can override it if you want. Defaults to ``"localhost"`` -`REDIS_PORT` is the port redis is serving on, defaults to 6379 +``REDIS_PORT``: is the port redis is serving on, defaults to 6379 -`SNAPPASS_REDIS_DB` is the database that you want to use on this redis server. Defaults to db 0 +``SNAPPASS_REDIS_DB``: is the database that you want to use on this redis server. Defaults to db 0 -`REDIS_URL` (optional) will be used instead of `REDIS_HOST`, `REDIS_PORT`, and `SNAPPASS_REDIS_DB` to configure the Redis client object. For example: redis://username:password@localhost:6379/0 +``REDIS_URL``: (optional) will be used instead of ``REDIS_HOST``, ``REDIS_PORT``, and ``SNAPPASS_REDIS_DB`` to configure the Redis client object. For example: redis://username:password@localhost:6379/0 -`REDIS_PREFIX` (optional, defaults to `"snappass"`) prefix used on redis keys to prevent collisions with other potential clients +``REDIS_PREFIX``: (optional, defaults to ``"snappass"``) prefix used on redis keys to prevent collisions with other potential clients Docker ------