Permalink
Browse files

Update docs and use themes submodule

  • Loading branch information...
1 parent f2c817f commit 06e3b32002e197a2d2021a5ebf7d77f546266525 @mattupstate committed Jun 12, 2012
Showing with 11 additions and 17 deletions.
  1. +3 −0 .gitmodules
  2. +1 −0 docs/_themes
  3. +3 −2 docs/conf.py
  4. +4 −15 docs/index.rst
View
3 .gitmodules
@@ -0,0 +1,3 @@
+[submodule "docs/_themes"]
+ path = docs/_themes
+ url = git://github.com/mitsuhiko/flask-sphinx-themes.git
1 docs/_themes
@@ -0,0 +1 @@
+Subproject commit 0269f3d188eaff07c44a800f35f7351f9e0aefb0
View
5 docs/conf.py
@@ -16,6 +16,7 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.abspath('_themes'))
# -- General configuration -----------------------------------------------------
@@ -45,9 +46,9 @@
# built documents.
#
# The short X.Y version.
-version = '0.6'
+version = '0.7'
# The full version, including alpha/beta/rc tags.
-release = '0.6'
+release = version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
View
19 docs/index.rst
@@ -11,17 +11,6 @@ The **Flask-Mail** extension provides a simple interface to set up SMTP with you
Source code and issue tracking at `GitHub`_.
-Windows issues
---------------
-
-**Flask-Mail** requires the use of the **Lamson** library, which unfortunately
-has dependencies that do not work on Windows.
-
-You can install Flask-Mail, Lamson and other libraries with the `no dependencies` option::
-
- easy_install -N lamson chardet Flask-Mail
-
-
Installing Flask-Mail
---------------------
@@ -65,14 +54,14 @@ options (each is explained later in the documentation):
* **MAIL_FAIL_SILENTLY** : default **True**
* **MAIL_SUPPRESS_SEND** : default **False**
-
+git
In addition the standard Flask ``TESTING`` configuration option is used by **Flask-Mail**
in unit tests (see below).
Emails are managed through a ``Mail`` instance::
from flask import Flask
- from flaskext.mail import Mail
+ from flask_mail import Mail
app = Flask(__name__)
mail = Mail(app)
@@ -91,7 +80,7 @@ Sending messages
To send a message first create a ``Message`` instance::
- from flaskext.mail import Message
+ from flask_mail import Message
@app.route("/")
def index():
@@ -231,7 +220,7 @@ app instance as an optional argument::
API
---
-.. module:: flaskext.mail
+.. module:: flask_mail
.. autoclass:: Mail
:members: send, connect, send_message

0 comments on commit 06e3b32

Please sign in to comment.