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 (#238)

* Add tests docs to CI and fix docs warning

* Switch to storing environment variables in travis outside of secure vars.

* Force a rebuild.

* Force a rebuild.

* Run integration tests just once per test run.

* Minor updates.

* Nevermind; this test class covers more than just integration tests.

* Attempting to fix docs build via https://stackoverflow.com/questions/61711710/runtimeerror-class-not-set-defining-abstractbaseuser-as-class-django-co\#comment112739057_63045563

* Minor docs fix.

Co-authored-by: Adam Coddington <me@adamcoddington.net>
This commit is contained in:
Adam Dobrawy 2020-12-07 03:10:15 +01:00 committed by GitHub
parent 225da2155f
commit 5abc1981dc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 27 additions and 23 deletions

View file

@ -40,7 +40,7 @@ master_doc = 'index'
# General information about the project.
project = 'django-mailbox'
copyright = '2014, Adam Coddington'
copyright = '2020, Adam Coddington'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@ -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.
@ -282,7 +282,7 @@ def process_docstring(app, what, name, obj, options, lines):
# Add the field's type to the docstring
if isinstance(field, models.ForeignKey):
to = field.rel.to
to = field.related_model
lines.append(':type {}: {} to :class:`~{}.{}`'.format(field.attname, type(field).__name__, to.__module__, to.__name__))
else:
lines.append(':type {}: {}'.format(field.attname, type(field).__name__))

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

@ -76,6 +76,8 @@ to the end of your URI::
imap+ssl://youremailaddress%40gmail.com:1234@imap.gmail.com?folder=MyFolder
.. _gmail-oauth:
Specifying an archive folder
++++++++++++++++++++++++++++
@ -91,8 +93,6 @@ after processing, add ``?archive=myarchivefolder`` to the end of the URI::
imap+ssl://youremailaddress%40gmail.com:1234@imap.gmail.com?archive=myarchivefolder
.. _gmail-oauth:
If you want to specifying both folder use ``&``::
imap+ssl://youremailaddress%40gmail.com:1234@imap.gmail.com?archive=myarchivefolder&folder=MyFolder