Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

make README more readable

  • Loading branch information...
commit d080eed1519bd1a4a0be02674f6197304dca2dd0 1 parent 2576191
@domenkozar authored
Showing with 17 additions and 17 deletions.
  1. +16 −15 README.rst
  2. +1 −2  setup.py
View
31 README.rst
@@ -1,8 +1,8 @@
Pyramid integration package for "A highly efficient and modular mail delivery
framework for Python 2.6+ and 3.1+, formerly TurboMail."
-Currently it must be used with `pyramid_tm`, as `Mailer.send` only works
-if `transaction`.commit() succeeded.
+Currently it must be used with ``pyramid_tm``, as ``Mailer.send`` only works
+if ``transaction``.commit() succeeded.
INSTALL
=======
@@ -19,22 +19,22 @@ If you have package installed, you can configure it in Pyramid like always::
config.include('pyramid_marrowmailer')
-All settings `marrow.mailer` expects are prefixed with `mail.`. If you want
-to use different prefix, set it with `pyramid_marrowmailer.prefix`.
+All settings ``marrow.mailer`` expects are prefixed with ``mail.``. If you want
+to use different prefix, set it with ``pyramid_marrowmailer.prefix``.
-To see what options `marrow.mailer` support, see
+To see what options ``marrow.mailer`` support, see
`the documentation <https://github.com/marrow/marrow.mailer>`_. Note that
-boolean options need a `.on` suffix. For example `mail.transport.debug.on = true`.
-Options that need to be converted to integer, add `int` suffix. For example
-`mail.transport.port.int = 1337`.
+boolean options need a ``.on`` suffix. For example ``mail.transport.debug.on = true``.
+Options that need to be converted to integer, add ``int`` suffix. For example
+``mail.transport.port.int = 1337``.
-`pyramid_marrowmailer` calls `Mailer.start` when `config.include('pyramid_marrowmailer')`
-is called. `atexit` is used to register `Mailer.stop` to shutdown when wsgi server will exit.
+``pyramid_marrowmailer`` calls ``Mailer.start`` when ``config.include('pyramid_marrowmailer')``
+is called. ``atexit`` is used to register ``Mailer.stop`` to shutdown when wsgi server will exit.
-Note that `pyramid_marrowmailer` subclasses `marrow.mailer.Mailer` to provide support for
-`transaction`. Class is importable from `pyramid_marrowmailer.TransactionMailer`
+Note that ``pyramid_marrowmailer`` subclasses ``marrow.mailer.Mailer`` to provide support for
+``transaction``. Class is importable from ``pyramid_marrowmailer.TransactionMailer``
-You can accces `pyramid_marrowmailer.TransactionMailer` instance in two ways::
+You can accces ``pyramid_marrowmailer.TransactionMailer`` instance in two ways::
mailer = request.mailer
message = mailer.new()
@@ -52,7 +52,7 @@ Or::
EXAMPLE
=======
-If we have paster `.ini` something like::
+If we have paster ``.ini`` something like::
mail.transport.use = smtp
mail.message.author = foobar@foo.com
@@ -80,4 +80,5 @@ TESTING
TODO
====
-- Add support to use `marrow.mailer` without usage of `transaction`
+- Add support to use ``marrow.mailer`` without usage of ``transaction``
+
View
3  setup.py
@@ -15,8 +15,7 @@ def read(*rnames):
description='Pyramid integration package for marrow.mailer,'
' formerly known as TurboMail',
long_description=read('README.rst') +
- read('HISTORY.rst') +
- read('LICENSE'),
+ read('HISTORY.rst'),
classifiers=[
"Programming Language :: Python",
"Framework :: Pyramid",
Please sign in to comment.
Something went wrong with that request. Please try again.