Updates, fixes, and improvements to documentation (#3976)

* Make the Django module installation steps consistent

* Fix typos and omissions in contribution docs

* Add a max_line_length, in accordance with contribution docs

* Add myself to the contributors

.editorconfig

@@ -9,6 +9,7 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 charset = utf-8
 end_of_line = lf
+max_line_length = 78
 
 [Makefile]
 indent_style = tab

CONTRIBUTING.rst

@@ -1,8 +1,8 @@
 .. _contributing:
 
-============
-Contributing
-============
+==============
+ Contributing
+==============
 
 Welcome!
 
@@ -475,7 +475,7 @@ dependencies, so install these next:
     $ pip install -U -r requirements/default.txt
 
 After installing the dependencies required, you can now execute
-the test suite by calling ``py.test <pytest``:
+the test suite by calling ``py.test <pytest>``:
 
 ::
 
@@ -582,11 +582,12 @@ Building the documentation
 --------------------------
 
 To build the documentation you need to install the dependencies
-listed in ``requirements/docs.txt``:
+listed in ``requirements/docs.txt`` and ``requirements/default.txt``:
 
 ::
 
     $ pip install -U -r requirements/docs.txt
+    $ pip install -U -r requirements/default.txt
 
 After these dependencies are installed you should be able to
 build the docs by running:
@@ -629,7 +630,7 @@ the ``flakes`` target instead:
 
 ::
 
-    $ make flakes§
+    $ make flakes
 
 API reference
 ~~~~~~~~~~~~~
@@ -748,14 +749,14 @@ is following the conventions.
 * Import order
 
     * Python standard library (`import xxx`)
-    * Python standard library ('from xxx import`)
+    * Python standard library (`from xxx import`)
     * Third-party packages.
     * Other modules from the current package.
 
     or in case of code using Django:
 
     * Python standard library (`import xxx`)
-    * Python standard library ('from xxx import`)
+    * Python standard library (`from xxx import`)
     * Third-party packages.
     * Django packages.
     * Other modules from the current package.
@@ -805,7 +806,7 @@ is following the conventions.
      support for Python 2.5)
 
 
-* Note that we use "new-style` relative imports when the distribution
+* Note that we use "new-style" relative imports when the distribution
   doesn't support Python versions below 2.5
 
     This requires Python 2.5 or later:

CONTRIBUTORS.txt

@@ -235,3 +235,4 @@ Ryan Hiebert, 2017/01/20
 Jianjian Yu, 2017/04/09
 Brian May, 2017/04/10
 Dmytro Petruk, 2017/04/12
+Joey Wilhelm, 2017/04/12

docs/contributing.rst

@@ -285,6 +285,7 @@ Branches
 Current active version branches:
 
 * dev (which git calls "master") (https://github.com/celery/celery/tree/master)
+* 4.0 (https://github.com/celery/celery/tree/4.0)
 * 3.1 (https://github.com/celery/celery/tree/3.1)
 * 3.0 (https://github.com/celery/celery/tree/3.0)
 
@@ -581,11 +582,12 @@ Building the documentation
 --------------------------
 
 To build the documentation you need to install the dependencies
-listed in :file:`requirements/docs.txt`:
+listed in :file:`requirements/docs.txt` and :file:`requirements/default.txt`:
 
 .. code-block:: console
 
     $ pip install -U -r requirements/docs.txt
+    $ pip install -U -r requirements/default.txt
 
 After these dependencies are installed you should be able to
 build the docs by running:
@@ -628,7 +630,7 @@ the ``flakes`` target instead:
 
 .. code-block:: console
 
-    $ make flakes§
+    $ make flakes
 
 API reference
 ~~~~~~~~~~~~~
@@ -747,14 +749,14 @@ is following the conventions.
 * Import order
 
     * Python standard library (`import xxx`)
-    * Python standard library ('from xxx import`)
+    * Python standard library (`from xxx import`)
     * Third-party packages.
     * Other modules from the current package.
 
     or in case of code using Django:
 
     * Python standard library (`import xxx`)
-    * Python standard library ('from xxx import`)
+    * Python standard library (`from xxx import`)
     * Third-party packages.
     * Django packages.
     * Other modules from the current package.
@@ -804,7 +806,7 @@ is following the conventions.
      support for Python 2.5)
 
 
-* Note that we use "new-style` relative imports when the distribution
+* Note that we use "new-style" relative imports when the distribution
   doesn't support Python versions below 2.5
 
     This requires Python 2.5 or later:

docs/django/first-steps-with-django.rst

@@ -86,7 +86,7 @@ from the Django settings; but you can also separate them if wanted.
 
 The uppercase name-space means that all Celery configuration options
 must be specified in uppercase instead of lowercase, and start with
-``CELERY_``, so for example the :setting:`task_always_eager`` setting
+``CELERY_``, so for example the :setting:`task_always_eager` setting
 becomes ``CELERY_TASK_ALWAYS_EAGER``, and the :setting:`broker_url`
 setting becomes ``CELERY_BROKER_URL``.
 
@@ -171,17 +171,23 @@ To use this with your project you need to follow these steps:
 
         $ pip install django-celery-results
 
-2. Add ``django_celery_results`` to ``INSTALLED_APPS``.
+#. Add ``django_celery_results`` to ``INSTALLED_APPS`` in your
+   Django project's :file:`settings.py`::
 
-    Note that there's no dashes in this name, only underscores.
+        INSTALLED_APPS = (
+            ...,
+            'django_celery_results',
+        )
 
-3. Create the Celery database tables by performing a database migrations:
+   Note that there is no dash in the module name, only underscores.
+
+#. Create the Celery database tables by performing a database migrations:
 
     .. code-block:: console
 
         $ python manage.py migrate django_celery_results
 
-4. Configure Celery to use the :pypi:`django-celery-results` backend.
+#. Configure Celery to use the :pypi:`django-celery-results` backend.
 
     Assuming you are using Django's :file:`settings.py` to also configure
     Celery, add the following settings:

docs/userguide/periodic-tasks.rst

@@ -439,7 +439,7 @@ To install and use this extension:
             'django_celery_beat',
         )
 
-    Note that there is no dash in the module name, only underscores.
+   Note that there is no dash in the module name, only underscores.
 
 #. Apply Django database migrations so that the necessary tables are created: