Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lingthio committed Feb 28, 2014
1 parent 6c58d7c commit f6a7440
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 20 deletions.
1 change: 1 addition & 0 deletions docs/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__author__ = 'lingthio'
1 change: 1 addition & 0 deletions docs/source/_themes
Submodule _themes added at 1cc446
4 changes: 4 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
import sys
import os

sys.path.append(os.path.abspath('_themes'))

# 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.
Expand Down Expand Up @@ -101,6 +103,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'nature'
#html_theme = 'flask'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand All @@ -109,6 +112,7 @@

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
html_theme_path = ['_themes']

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand Down
37 changes: 22 additions & 15 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
Flask-User
==========

.. image:: https://pypip.in/v/Flask-User/badge.png
:target: https://pypi.python.org/pypi/Flask-User

Expand All @@ -18,8 +17,12 @@ Flask-User

::

!! Newsflash: In v0.3.1 and v0.3.2 confirmation emails were not working !!
Please upgrade to v0.3.3 or later. Thank you.
!! Newsflash !!
In v0.3.1 and v0.3.2 confirmation emails were not working
Please upgrade to v0.3.3 or later. Thank you.

!! Headsup !!
The upcoming v0.4 will break v0.3 compatibility. See the Status section below.

Customizable User Login for Flask: Register, Confirm email, Login, Forgot password and more
-------------------------------------------------------------------------------------------
Expand All @@ -35,18 +38,22 @@ Flask-User aims to provide a ready to use **and** fully customizable package tha
* **Fully customizable** (Field labels, Flash messages, Form templates, Emails, URLs, and more)
* **Well documented**

Documentation
-------------
.. toctree::
:maxdepth: 1

features
install
minimal-app
basic-app
customize
signals
revision-history
Status
------

v0.3 is an Alpha release. We would appreciate it if you enter issues, suggestions and
feature requests into the `Flask-User Issue Tracker <https://github.com/lingthio/flask-user/issues>`_.

v0.4 is in active development AND WILL BREAK v0.3 COMPATIBILITY. The main purpose of this release is:

* Allowing full Flask-Login customization
* Offering view functions as over-loadable class functions
* Breaking view function content into re-usable helper functions
to ease view function customization

Revision History
----------------
See :doc:`revision-history`

Extension Packages
------------------
Expand Down
9 changes: 4 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,16 @@
setup(
name='Flask-User',
version='0.3.5',
url='http://github.com/lingthio/flask-user',
license='BSD License',
author='Ling Thio',
author_email='ling.thio@gmail.com',
url='http://github.com/lingthio/flask-user',
description='Customizable User Login for Flask: Register, Confirm email, Login, Forgot password and more',
keywords='Flask User Registration Email Confirmation Reset',
long_description=__doc__,
keywords='Flask User Registration Email Username Confirmation Password Reset',
packages=['flask_user'],
include_package_data=True,
zip_safe=False,
include_package_data=True,
platforms='any',
install_requires=[
'passlib',
Expand Down Expand Up @@ -112,6 +113,4 @@
'Topic :: Security',
'Topic :: Software Development :: Libraries :: Python Modules',
],
#cmdclass={'audit': run_audit},
#test_suite='flask.testsuite.suite'
)

0 comments on commit f6a7440

Please sign in to comment.