Skip to content

Commit 431ab3b

Browse files
authored
Merge pull request #57 from samueldg/fix/misc-docs
Various documentation fixes and improvements
2 parents 9a404d1 + 57a40a0 commit 431ab3b

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

AUTHORS.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Credits
66
It is currently maintained by Nicholas Charriere and Yongwen Xu from Pinterest.
77

88
Thanks a lot for the contributions of:
9+
910
* Owen Coutts
1011
* Ryan Park
1112
* Yongwen Xu

README.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,13 @@ Configuration
5151
You can configure the following via environment variables.
5252

5353
`SECRET_KEY` this should be a unique key that's used to sign key. This should
54-
be kept secret. See the `Flask Documentation`_ for more information.
54+
be kept secret. See the `Flask Documentation`__ for more information.
5555

56-
`DEBUG` to run Flask web werver in debug mode. See the `Flask Documentation`_ for more information.
56+
.. __: http://flask.pocoo.org/docs/quickstart/#sessions
5757

58-
.. _Flask Documentation: http://flask.pocoo.org/docs/quickstart/#sessions
58+
`DEBUG` to run Flask web server in debug mode. See the `Flask Documentation`__ for more information.
59+
60+
.. __: http://flask.pocoo.org/docs/quickstart/#debug-mode
5961

6062
`STATIC_URL` this should be the location of your static assets. You might not
6163
need to change this.
@@ -77,8 +79,9 @@ Alternatively, you can use `Docker`_ and `Docker Compose`_ to install and run Sn
7779

7880
.. _Docker: https://www.docker.com/
7981
.. _Docker Compose: https://docs.docker.com/compose/
82+
8083
::
8184

8285
$ docker-compose up -d
8386

84-
This will pull all dependencies, i.e. Redis and appropriate Python version (3.6), then start up snappass and Redis server. SnapPass server is accessible at: http://localhost:5000
87+
This will pull all dependencies, i.e. Redis and appropriate Python version (3.6), then start up SnapPass and Redis server. SnapPass server is accessible at: http://localhost:5000

0 commit comments

Comments
 (0)