1
0
Fork 1
mirror of https://github.com/coddingtonbear/django-mailbox.git synced 2026-07-09 22:38:19 +02:00

Add tests docs to CI and fix docs warning

This commit is contained in:
Adam Dobrawy 2020-10-14 00:26:57 +02:00
parent 225da2155f
commit 62db0c55c2
6 changed files with 20 additions and 10 deletions

View file

@ -3,6 +3,8 @@ os: linux
language: python
jobs:
- env: TOX_ENV=docs
python: 3.8
# sort by django version, next to by python version
# Django 1.11 support all supported Python interpreter
- env: TOX_ENV=django111-py35

View file

@ -701,11 +701,11 @@ class Message(models.Model):
self.body = base64.b64encode(body.encode('utf-8')).decode('ascii')
def get_email_object(self):
"""Returns an `email.message.Message` instance representing the
"""Returns an `email.message.EmailMessage` instance representing the
contents of this message and all attachments.
See [email.Message.Message]_ for more information as to what methods
and properties are available on `email.message.Message` instances.
See [email.message.EmailMessage]_ for more information as to what methods
and properties are available on `email.message.EmailMessage` instances.
.. note::
@ -715,8 +715,8 @@ class Message(models.Model):
using stored attachments, or read the message contents stored
on-disk.
.. [email.Message.Message]: Python's `email.message.Message` docs
(https://docs.python.org/2/library/email.message.html)
.. [email.message.EmailMessage] Python's `email.message.EmailMessage` docs
(https://docs.python.org/3/library/email.message.html)
"""
if not hasattr(self, '_email_object'): # Cache fill

View file

@ -119,7 +119,7 @@ html_theme = 'default'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.

View file

@ -5,7 +5,7 @@ Message Storage Details
First, it may be helpful to know a little bit about how e-mail messages
are actually sent across the wire:
.. code-block:: http
.. code-block::
MIME-Version: 1.0
Received: by 10.221.0.211 with HTTP; Sun, 20 Jan 2013 12:07:07 -0800 (PST)
@ -52,7 +52,7 @@ and alter the message body removing the original payload component, but writing
a custom header providing the library enough information to re-build the
message in the event that one needs a python ``email.message.Message`` object.
.. code-block:: http
.. code-block::
MIME-Version: 1.0
Received: by 10.221.0.211 with HTTP; Sun, 20 Jan 2013 12:07:07 -0800 (PST)
@ -113,7 +113,7 @@ in the place of the original attachment, the attachment was stored in a
And were one to run the ``django_mailbox.Message`` instance's
``get_email_object`` method, the following message will be returned:
.. code-block:: http
.. code-block::
MIME-Version: 1.0
Received: by 10.221.0.211 with HTTP; Sun, 20 Jan 2013 12:07:07 -0800 (PST)

View file

@ -44,7 +44,7 @@ To enroll a new release you should perform the following task:
* Push a new release to PyPI - ``python setup.py sdist bdist_wheel upload``.
How to add support for a new Django version?
------------------------------------------
--------------------------------------------
Changes are only necessary for new minor or major Django versions.

View file

@ -22,6 +22,14 @@ commands=
python {toxinidir}/manage.py makemigrations --check --dry-run
python -Wd manage.py test -v2 {posargs}
[testenv:docs]
deps=
sphinx
-r{toxinidir}/rtd_requirements.txt
commands=make html clean SPHINXOPTS="-W --keep-going"
changedir={toxinidir}/docs
allowlist_externals=make
[testenv:flake8]
deps=flake8
commands=flake8 django_mailbox