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

Merge pull request #281 from pfouque/documentation

Browse source 
Update Documentation
This commit is contained in:
Pascal Fouque 2023-12-15 20:37:07 +01:00 • committed by GitHub
commit 70d35943f3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 10 additions and 923 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/index.rst
View file

@ -6,8 +6,8 @@
Django-mailbox
==============
.. image:: https://travis-ci.org/coddingtonbear/django-mailbox.png?branch=master
:target: https://travis-ci.org/coddingtonbear/django-mailbox
.. image:: https://github.com/coddingtonbear/django-mailbox/actions/workflows/main.yml/badge.svg
:target: https://github.com/coddingtonbear/django-mailbox/actions/workflows/main.yml
How many times have you had to consume some sort of POP3, IMAP, or local mailbox for incoming content,
or had to otherwise construct an application driven by e-mail?

8
docs/topics/development.rst
View file

@ -8,7 +8,7 @@ make it simple.
How to file a ticket?
---------------------
Just go to https://github.com/coddingtonbear/django-mailbox and create new
Just go to https://github.com/coddingtonbear/django-mailbox/issues and create new
one.
@ -50,10 +50,8 @@ Changes are only necessary for new minor or major Django versions.
To add support for a new version perform the following task:
* Ensure that ``.github/workflows/main.yml`` file reflects support for new Python release.
* Ensure that ``tox.ini`` file reflects support for new Django release.
* Verify in tox that the code is executed correctly on all versions of the Python interpreter.
* Ensure that ``.travis.yml`` file reflects support for new Django release. Note the excluded versions of the Python interpreter.
* Verify by pushing changes on a separate branch to see if the changes in TravisCI are correct.
* Verify by pushing changes on a separate branch to see if the changes in Github Actions are correct.
* Proceed to the standard procedure for a new package release (see `How to do a new release?`_ ).
A `spreadsheet with generator is available <https://docs.google.com/spreadsheets/d/1YsVPDeOAgf_c_7XOXh6SZUO2ebMNoFXysxfj4r1tFiM/edit?usp=sharing>`_ that can assist this process.