doc

Author: blueyed

docs/changelog.rst

@@ -4,13 +4,24 @@ Changelog
 3.3.0 (unreleased)
 ------------------
 
-* Fix test for classmethod with Django TestCases (#597, #598).
-* Fix RemovedInPytest4Warning: MarkInfo objects are deprecated (#596, #603)
+Features
+^^^^^^^^
+
+* Added new fixtures ``django_mail_dnsname`` and ``django_mail_patch_dns``,
+  used by ``mailoutbox`` to monkeypatch the ``DNS_NAME`` used in
+  :py:mod:`django.core.mail` to improve performance and
+  reproducibility.
+
+Bug fixes
+^^^^^^^^^
+
+* Fixed test for classmethod with Django TestCases (#597, #598).
+* Fixed RemovedInPytest4Warning: MarkInfo objects are deprecated (#596, #603)
 
 3.2.1
 -----
 
-Fix automatic deployment to PyPI.
+* Fixed automatic deployment to PyPI.
 
 3.2.0
 -----

docs/conf.py

@@ -14,6 +14,7 @@
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
     'pytestdocs',
 ]
 
@@ -60,3 +61,9 @@
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'pytest-djangodoc'
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'django': ('http://docs.djangoproject.com/en/dev/',
+               'http://docs.djangoproject.com/en/dev/_objects/'),
+}

docs/helpers.rst

@@ -264,7 +264,7 @@ Example
 
 
 ``mailoutbox``
-~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~
 
 A clean email outbox to which Django-generated emails are sent.
 
@@ -285,6 +285,12 @@ Example
         assert list(m.to) == ['to@example.com']
 
 
+This uses the ``django_mail_patch_dns`` fixture, which patches
+``DNS_NAME`` used by :py:mod:`django.core.mail` with the value from
+the ``django_mail_dnsname`` fixture, which defaults to
+"fake-tests.example.com".
+
+
 Automatic cleanup
 -----------------