Merge pull request #2861 from jwflory/fix/uwsgi-docs

[docs] Fix broken Sphinx cross-references; use :doc: tags where necessary

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
 ------
 

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`
+`cherokee`_; see :doc:`uwsgi` and :doc:`wsgi-standalone` for other options. To
-for other options.  To use your WSGI application with any of them you will need
+use your WSGI application with any of them you will need a FastCGI server first.
-a FastCGI server first.  The most popular one is `flup`_ which we will use for
+The most popular one is `flup`_ which we will use for this guide. Make sure to
-this guide.  Make sure to have it installed to follow along.
+have it installed to follow along.
 
 .. admonition:: Watch Out
 

docs/deploying/uwsgi.rst

@@ -4,10 +4,10 @@ uWSGI
 =====
 
 uWSGI is a deployment option on servers like `nginx`_, `lighttpd`_, and
-`cherokee`_; see :ref:`deploying-fastcgi` and :ref:`deploying-wsgi-standalone`
+`cherokee`_; see :doc:`fastcgi` and :doc:`wsgi-standalone` for other options.
-for other options.  To use your WSGI application with uWSGI protocol you will
+To use your WSGI application with uWSGI protocol you will need a uWSGI server
-need a uWSGI server first. uWSGI is both a protocol and an application server;
+first. uWSGI is both a protocol and an application server; the application
-the application server can serve uWSGI, FastCGI, and HTTP protocols.
+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.
@@ -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
+since it is smarter about that. It is used together with the ``--mount``
-which will make requests to ``/yourapplication`` be directed to ``myapp:app``.
+directive which will make requests to ``/yourapplication`` be directed to
-If your application is accessible at root level, you can use a single ``/``
+``myapp:app``. If your application is accessible at root level, you can use a
-instead of ``/yourapplication``. ``myapp`` refers to the name of the file of
+single ``/`` instead of ``/yourapplication``. ``myapp`` refers to the name of
-your flask application (without extension) or the module which provides ``app``.
+the file of your flask application (without extension) or the module which
-``app`` is the callable inside of your application (usually the line reads
+provides ``app``. ``app`` is the callable inside of your application (usually
-``app = Flask(__name__)``.
+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

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 <deploying-uwsgi>`.
+For a more optimized setup, see :doc:`configuring uWSGI and NGINX <uwsgi>`.
 
 .. _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