Skip to content

Commit 6ef1349

Browse files
committed
GitHub doesn't like Sphinx directives in rst
1 parent 37a54cd commit 6ef1349

File tree

2 files changed

+18
-9
lines changed

2 files changed

+18
-9
lines changed

README.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
Anymail: Multi-ESP transactional email for Django
22
=================================================
33

4+
**EARLY DEVELOPMENT**
5+
6+
This project is undergoing rapid development to get to a 1.0 release.
7+
You should expect frequent, possibly-breaking changes until 1.0 alpha.
8+
49
.. This README is reused in multiple places:
510
* Github: project page, exactly as it appears here
611
* Docs: shared-intro section gets included in docs/index.rst
@@ -9,6 +14,8 @@ Anymail: Multi-ESP transactional email for Django
914
with several edits to freeze it to the specific PyPI release
1015
(see long_description_from_readme in setup.py)
1116
You can use docutils 1.0 markup, but *not* any Sphinx additions.
17+
GitHub rst supports code-block, but *no other* block directives.
18+
1219
1320
.. default-role:: literal
1421

@@ -22,15 +29,6 @@ using a consistent API that makes it (relatively) easy to switch between ESPs.
2229

2330
It currently supports Mailgun and Mandrill. Postmark and SendGrid are coming soon.
2431

25-
.. attention:: **EARLY DEVELOPMENT**
26-
27-
This project is undergoing rapid development to get to a 1.0 release.
28-
You should expect frequent, possibly-breaking changes until 1.0 alpha.
29-
30-
If you are migrating to Anymail from `Djrill <https://github.com/brack3t/Djrill>`_,
31-
there are `notes on porting <https://anymail.readthedocs.org/en/latest/esps/mandrill/#migrating-from-djrill>`_
32-
33-
3432
Anymail normalizes ESP functionality so it "just works" with Django's
3533
built-in `django.core.mail` package. It includes:
3634

docs/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,17 @@ Anymail: Multi-ESP transactional email for Django
33

44
Version |release|
55

6+
.. attention:: **EARLY DEVELOPMENT**
7+
8+
This project is undergoing rapid development to get to a 1.0 release.
9+
You should expect frequent, possibly-breaking changes until 1.0 alpha.
10+
11+
If you are switching to Anymail from `Djrill`_,
12+
see the notes on :ref:`migrating-from-djrill`
13+
14+
.. _Djrill: https://github.com/brack3t/Djrill
15+
16+
617
.. Incorporate the shared-intro section from the root README:
718
819
.. include:: ../README.rst

0 commit comments

Comments
 (0)