From 72dfb67828be9da6407a3199782bd2e2ad2d44ff Mon Sep 17 00:00:00 2001 From: "Justin W. Flory" Date: Wed, 11 Jul 2018 09:38:17 -0500 Subject: [PATCH 1/2] Make explicit call-out to contributing guidelines in README --- README.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.rst b/README.rst index f2906aae..4243793c 100644 --- a/README.rst +++ b/README.rst @@ -43,6 +43,15 @@ A Simple Example * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit) +Contributing +------------ + +For guidance on setting up a development environment and how to make a +contribution to Flask, see the `contributing guidelines`_. + +.. _contributing guidelines: https://github.com/pallets/flask/blob/master/CONTRIBUTING.rst + + Donate ------ From e771016a5bac3c08987907a2ec63385d58b81be0 Mon Sep 17 00:00:00 2001 From: "Justin W. Flory" Date: Wed, 11 Jul 2018 09:49:18 -0500 Subject: [PATCH 2/2] Fix broken cross-references; use :doc: tags where necessary --- docs/deploying/fastcgi.rst | 8 ++++---- docs/deploying/uwsgi.rst | 24 ++++++++++++------------ docs/deploying/wsgi-standalone.rst | 2 +- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/deploying/fastcgi.rst b/docs/deploying/fastcgi.rst index 3d57eb9b..26d181a5 100644 --- a/docs/deploying/fastcgi.rst +++ b/docs/deploying/fastcgi.rst @@ -4,10 +4,10 @@ FastCGI ======= FastCGI is a deployment option on servers like `nginx`_, `lighttpd`_, and -`cherokee`_; see :ref:`deploying-uwsgi` and :ref:`deploying-wsgi-standalone` -for other options. To use your WSGI application with any of them you will need -a FastCGI server first. The most popular one is `flup`_ which we will use for -this guide. Make sure to have it installed to follow along. +`cherokee`_; see :doc:`uwsgi` and :doc:`wsgi-standalone` for other options. To +use your WSGI application with any of them you will need a FastCGI server first. +The most popular one is `flup`_ which we will use for this guide. Make sure to +have it installed to follow along. .. admonition:: Watch Out diff --git a/docs/deploying/uwsgi.rst b/docs/deploying/uwsgi.rst index 50c85fb2..d0501a35 100644 --- a/docs/deploying/uwsgi.rst +++ b/docs/deploying/uwsgi.rst @@ -4,13 +4,13 @@ uWSGI ===== uWSGI is a deployment option on servers like `nginx`_, `lighttpd`_, and -`cherokee`_; see :ref:`deploying-fastcgi` and :ref:`deploying-wsgi-standalone` -for other options. To use your WSGI application with uWSGI protocol you will -need a uWSGI server first. uWSGI is both a protocol and an application server; -the application server can serve uWSGI, FastCGI, and HTTP protocols. +`cherokee`_; see :doc:`fastcgi` and :doc:`wsgi-standalone` for other options. +To use your WSGI application with uWSGI protocol you will need a uWSGI server +first. uWSGI is both a protocol and an application server; the application +server can serve uWSGI, FastCGI, and HTTP protocols. The most popular uWSGI server is `uwsgi`_, which we will use for this -guide. Make sure to have it installed to follow along. +guide. Make sure to have it installed to follow along. .. admonition:: Watch Out @@ -32,13 +32,13 @@ Given a flask application in myapp.py, use the following command: $ uwsgi -s /tmp/yourapplication.sock --manage-script-name --mount /yourapplication=myapp:app The ``--manage-script-name`` will move the handling of ``SCRIPT_NAME`` to uwsgi, -since its smarter about that. It is used together with the ``--mount`` directive -which will make requests to ``/yourapplication`` be directed to ``myapp:app``. -If your application is accessible at root level, you can use a single ``/`` -instead of ``/yourapplication``. ``myapp`` refers to the name of the file of -your flask application (without extension) or the module which provides ``app``. -``app`` is the callable inside of your application (usually the line reads -``app = Flask(__name__)``. +since it is smarter about that. It is used together with the ``--mount`` +directive which will make requests to ``/yourapplication`` be directed to +``myapp:app``. If your application is accessible at root level, you can use a +single ``/`` instead of ``/yourapplication``. ``myapp`` refers to the name of +the file of your flask application (without extension) or the module which +provides ``app``. ``app`` is the callable inside of your application (usually +the line reads ``app = Flask(__name__)``. If you want to deploy your flask application inside of a virtual environment, you need to also add ``--virtualenv /path/to/virtual/environment``. You might diff --git a/docs/deploying/wsgi-standalone.rst b/docs/deploying/wsgi-standalone.rst index 98a52e71..aeff9f0f 100644 --- a/docs/deploying/wsgi-standalone.rst +++ b/docs/deploying/wsgi-standalone.rst @@ -37,7 +37,7 @@ Running `uWSGI HTTP Router`_:: uwsgi --http 127.0.0.1:5000 --module myproject:app -For a more optimized setup, see :ref:`configuring uWSGI and NGINX `. +For a more optimized setup, see :doc:`configuring uWSGI and NGINX `. .. _uWSGI: http://uwsgi-docs.readthedocs.io/en/latest/ .. _uWSGI HTTP Router: http://uwsgi-docs.readthedocs.io/en/latest/HTTP.html#the-uwsgi-http-https-router