pacnpal/django-anymail
1
0
Fork 0
mirror of https://github.com/pacnpal/django-anymail.git synced 2025-12-20 03:41:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

GitHub doesn't like Sphinx directives in rst

Browse Source
This commit is contained in:
medmunds
2016-03-09 19:30:34 -08:00
parent 37a54cde3f
commit 6ef1349b65
2 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@@ -1,6 +1,11 @@
Anymail: Multi-ESP transactional email for Django
=================================================
**EARLY DEVELOPMENT**
This project is undergoing rapid development to get to a 1.0 release.
You should expect frequent, possibly-breaking changes until 1.0 alpha.
.. This README is reused in multiple places:
* Github: project page, exactly as it appears here
* Docs: shared-intro section gets included in docs/index.rst
@@ -9,6 +14,8 @@ Anymail: Multi-ESP transactional email for Django
with several edits to freeze it to the specific PyPI release
(see long_description_from_readme in setup.py)
You can use docutils 1.0 markup, but *not* any Sphinx additions.
GitHub rst supports code-block, but *no other* block directives.
.. default-role:: literal
@@ -22,15 +29,6 @@ using a consistent API that makes it (relatively) easy to switch between ESPs.
It currently supports Mailgun and Mandrill. Postmark and SendGrid are coming soon.
.. attention:: **EARLY DEVELOPMENT**
This project is undergoing rapid development to get to a 1.0 release.
You should expect frequent, possibly-breaking changes until 1.0 alpha.
If you are migrating to Anymail from `Djrill <https://github.com/brack3t/Djrill>`_,
there are `notes on porting <https://anymail.readthedocs.org/en/latest/esps/mandrill/#migrating-from-djrill>`_
Anymail normalizes ESP functionality so it "just works" with Django's
built-in `django.core.mail` package. It includes:

11
docs/index.rst
View File

@@ -3,6 +3,17 @@ Anymail: Multi-ESP transactional email for Django
Version |release|
.. attention:: **EARLY DEVELOPMENT**
This project is undergoing rapid development to get to a 1.0 release.
You should expect frequent, possibly-breaking changes until 1.0 alpha.
If you are switching to Anymail from `Djrill`_,
see the notes on :ref:`migrating-from-djrill`
.. _Djrill: https://github.com/brack3t/Djrill
.. Incorporate the shared-intro section from the root README:
.. include:: ../README.rst