Merge branch 'master' of bitbucket.org:cedricbonhomme/pyaggr3g470r

8 files changed, 785 insertions, 175 deletions

diff --git a/README.rst b/README.rst
index 831297e5..4075d7b4 100644
--- a/README.rst
+++ b/README.rst
@@ -23,169 +23,18 @@ Features
 * share articles with Google +, Pinboard and reddit;
 * HTTP proxy support.
 
-
-Usage
-=====
-
 Python 3.4 is recommended.
 
-Deployment
-----------
-
-This application can be deployed on Heroku or on a traditional server.
-
-After installation, you will be able to connect with the email *root@pyAggr3g470r.localhost* and the password *password*.
-
-Deploying the application with Vagrant
-''''''''''''''''''''''''''''''''''''''
-
-Installation of VirtualBox and Vagrant
-
-.. code:: bash
-
-    $ sudo apt-get install virtualbox
-    $ wget https://dl.bintray.com/mitchellh/vagrant/vagrant_1.6.5_x86_64.deb
-    $ sudo dpkg -i vagrant_1.6.5_x86_64.deb
-
-Deployment of pyAggr3g470r
-
-.. code:: bash
-
-    $ git clone https://bitbucket.org/cedricbonhomme/pyaggr3g470r.git
-    $ cd pyaggr3g470r/vagrant/
-    $ vagrant up
-
-Once the VM configured, go to the address http://127.0.0.1:5000.
-
-Deploying the application on Heroku
-'''''''''''''''''''''''''''''''''''
-
-An instance of pyAggr3g470r is running `here <https://pyaggr3g470r.herokuapp.com>`_.
-
-The geek way
-~~~~~~~~~~~~
-
-.. code:: bash
-
-    $ git clone https://bitbucket.org/cedricbonhomme/pyaggr3g470r.git
-    $ cd pyaggr3g470r
-    $ heroku create
-    $ heroku addons:add heroku-postgresql:dev
-    $ heroku config:set HEROKU=1
-    $ git push heroku master
-    $ heroku run init
-    $ heroku ps:scale web=1
-
-To enable account creation for users, you have to set some environment variables:
-
-.. code:: bash
-
-    $ heroku config:set SELF_REGISTRATION=1
-    $ heroku config:set PLATFORM_URL=<URL-of-your-platform>
-    $ heroku config:set RECAPTCHA_PUBLIC_KEY=<your-recaptcha-public-key>
-    $ heroku config:set RECAPTCHA_PRIVATE_KEY=<your-recaptcha-private-key>
-    $ heroku config:set NOTIFICATION_EMAIL=<notification-email>
-    $ heroku config:set POSTMARK_API_KEY=<your-postmark-api-key>
-    $ heroku addons:add postmark:10k
-
-`Postmark <https://postmarkapp.com/>`_ is used to send account confirmation links.
-
-If you don't want to open your platform just set *SELF_REGISTRATION* to 0.
-You will be still able to create accounts via the administration page.
-
-
-The simple way
-~~~~~~~~~~~~~~
-
-Alternatively, you can deploy your own copy of the app using this button:
-
-.. image:: https://www.herokucdn.com/deploy/button.png
-    :target: https://heroku.com/deploy?template=https://github.com/cedricbonhomme/pyAggr3g470r
-
-You will be prompted to choose an email and a password for the administrator's account.
-And some other optional environment variables, as previously presented.
-
-Deploying the application on a traditional server
-'''''''''''''''''''''''''''''''''''''''''''''''''
-
-.. code:: bash
-
-    $ sudo apt-get install python libpq-dev python-dev python-pip build-essential git
-    $ sudo apt-get install libxml2-dev libxslt1-dev # for lxml
-    $ git clone https://bitbucket.org/cedricbonhomme/pyaggr3g470r.git
-    $ cd pyaggr3g470r
-    $ sudo pip install --upgrade -r requirements.txt
-    $ cp conf/conf.cfg-sample conf/conf.cfg
-
-If you want to use PostgreSQL
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. code:: bash
-
-    $ sudo apt-get install postgresql postgresql-server-dev-9.3 postgresql-client
-    $ echo "127.0.0.1:5432:aggregator:pgsqluser:pgsqlpwd" > ~/.pgpass
-    $ chmod 700 ~/.pgpass
-    $ sudo -u postgres createuser pgsqluser --no-superuser --createdb --no-createrole
-    $ createdb aggregator --no-password
-    $ echo "ALTER USER pgsqluser WITH ENCRYPTED PASSWORD 'pgsqlpwd';" | sudo -u postgres psql
-    $ echo "GRANT ALL PRIVILEGES ON DATABASE aggregator TO pgsqluser;" | sudo -u postgres psql
-
-Edit the configuration file with the line:
-
-.. code:: cfg
-
-    [database]
-    uri = postgres://pgsqluser:pgsqlpwd@127.0.0.1:5433/aggregator
-
-If you want to use SQLite
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Just edit the configuration file with the line:
-
-.. code:: cfg
-
-    [database]
-    uri = sqlite+pysqlite:///pyAggr3g470r.db
-
-
-Finally:
-
-.. code:: bash
-
-    $ python db_create.py
-    $ python runserver.py
-     * Running on http://0.0.0.0:5000/
-     * Restarting with reloader
-
-
-Configuration
--------------
-
-Configuration (database url, email, proxy, user agent, etc.) is done via the file *conf/conf.cfg*.
-Check these configuration before executing *db_create.py*.   
-If you want to use pyAggr3g470r with Tor/Privoxy, you just have to set the value of
-*http_proxy* (most of the time: *http_proxy = 127.0.0.1:8118**). Else leave the value blank.
-
-
-Automatic updates
------------------
-
-You can fetch new articles with `cron <https://en.wikipedia.org/wiki/Cron>`_  and the script *fetch.py*.
-For example if you want to check for updates every 30 minutes, add this line to your cron rules (*crontab -e*):
-
-.. code:: bash
-
-    */30 * * * * cd ~/.pyaggr3g470r/ ; python fetch.py firstname.lastname@mail.com
-
-You must give the email address you use to login to pyAggr3g470r.
-
 
 Documentation
 =============
 
-* `web services <documentation/web-services.rst>`_;
-* `migrations <documentation/migrations.rst>`_
+A documentation is available `here <https://pyaggr3g470r.readthedocs.org>`_.
+
+Internationalization
+====================
 
+pyAggr3g470r is translated into English and French.
 
 Donation
 ========
@@ -195,19 +44,12 @@ If you wish and if you like *pyAggr3g470r*, you can donate via bitcoin
 Thank you!
 
 
-Internationalization
-====================
-
-pyAggr3g470r is translated into English and French.
-
-
 License
 =======
 
 `pyAggr3g470r <https://bitbucket.org/cedricbonhomme/pyaggr3g470r>`_
 is under the `GNU Affero General Public License version 3 <https://www.gnu.org/licenses/agpl-3.0.html>`_.
 
-
 Contact
 =======
 
diff --git a/documentation/Makefile b/documentation/Makefile
new file mode 100644
index 00000000..18130862
--- /dev/null
+++ b/documentation/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyAggr3g470r.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyAggr3g470r.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/pyAggr3g470r"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyAggr3g470r"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/documentation/conf.py b/documentation/conf.py
new file mode 100644
index 00000000..b148de9d
--- /dev/null
+++ b/documentation/conf.py
@@ -0,0 +1,242 @@
+# -*- coding: utf-8 -*-
+#
+# pyAggr3g470r documentation build configuration file, created by
+# sphinx-quickstart on Fri Feb 20 07:23:42 2015.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# 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('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'pyAggr3g470r'
+copyright = u'2015, Cédric Bonhomme'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '6.0'
+# The full version, including alpha/beta/rc tags.
+release = '6.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# 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
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pyAggr3g470rdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'pyAggr3g470r.tex', u'pyAggr3g470r Documentation',
+   u'Cédric Bonhomme', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'pyaggr3g470r', u'pyAggr3g470r Documentation',
+     [u'Cédric Bonhomme'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'pyAggr3g470r', u'pyAggr3g470r Documentation',
+   u'Cédric Bonhomme', 'pyAggr3g470r', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
diff --git a/documentation/deployment.rst b/documentation/deployment.rst
new file mode 100644
index 00000000..d0639c45
--- /dev/null
+++ b/documentation/deployment.rst
@@ -0,0 +1,149 @@
+Deployment
+==========
+
+This application can be deployed on Heroku or on a traditional server.
+
+After installation, you will be able to connect with the email *root@pyAggr3g470r.localhost* and the password *password*.
+
+Deploying the application with Vagrant
+--------------------------------------
+
+Installation of VirtualBox and Vagrant
+
+.. code-block:: bash
+
+    $ sudo apt-get install virtualbox
+    $ wget https://dl.bintray.com/mitchellh/vagrant/vagrant_1.6.5_x86_64.deb
+    $ sudo dpkg -i vagrant_1.6.5_x86_64.deb
+
+Deployment of pyAggr3g470r
+
+.. code-block:: bash
+
+    $ git clone https://bitbucket.org/cedricbonhomme/pyaggr3g470r.git
+    $ cd pyaggr3g470r/vagrant/
+    $ vagrant up
+
+Once the VM configured, go to the address http://127.0.0.1:5000.
+
+Deploying the application on Heroku
+-----------------------------------
+
+An instance of pyAggr3g470r is running `here <https://pyaggr3g470r.herokuapp.com>`_.
+
+The geek way
+''''''''''''
+
+.. code-block:: bash
+
+    $ git clone https://bitbucket.org/cedricbonhomme/pyaggr3g470r.git
+    $ cd pyaggr3g470r
+    $ heroku create
+    $ heroku addons:add heroku-postgresql:dev
+    $ heroku config:set HEROKU=1
+    $ git push heroku master
+    $ heroku run init
+    $ heroku ps:scale web=1
+
+To enable account creation for users, you have to set some environment variables:
+
+.. code-block:: bash
+
+    $ heroku config:set SELF_REGISTRATION=1
+    $ heroku config:set PLATFORM_URL=<URL-of-your-platform>
+    $ heroku config:set RECAPTCHA_PUBLIC_KEY=<your-recaptcha-public-key>
+    $ heroku config:set RECAPTCHA_PRIVATE_KEY=<your-recaptcha-private-key>
+    $ heroku config:set NOTIFICATION_EMAIL=<notification-email>
+    $ heroku config:set POSTMARK_API_KEY=<your-postmark-api-key>
+    $ heroku addons:add postmark:10k
+
+`Postmark <https://postmarkapp.com/>`_ is used to send account confirmation links.
+
+If you don't want to open your platform just set *SELF_REGISTRATION* to 0.
+You will be still able to create accounts via the administration page.
+
+
+The simple way
+''''''''''''''
+
+Alternatively, you can deploy your own copy of the app using this button:
+
+.. image:: https://www.herokucdn.com/deploy/button.png
+    :target: https://heroku.com/deploy?template=https://github.com/cedricbonhomme/pyAggr3g470r
+
+You will be prompted to choose an email and a password for the administrator's account.
+And some other optional environment variables, as previously presented.
+
+Deploying the application on a traditional server
+-------------------------------------------------
+
+.. code-block:: bash
+
+    $ sudo apt-get install python libpq-dev python-dev python-pip build-essential git
+    $ sudo apt-get install libxml2-dev libxslt1-dev # for lxml
+    $ git clone https://bitbucket.org/cedricbonhomme/pyaggr3g470r.git
+    $ cd pyaggr3g470r
+    $ sudo pip install --upgrade -r requirements.txt
+    $ cp conf/conf.cfg-sample conf/conf.cfg
+
+If you want to use PostgreSQL
+'''''''''''''''''''''''''''''
+
+.. code-block:: bash
+
+    $ sudo apt-get install postgresql postgresql-server-dev-9.3 postgresql-client
+    $ echo "127.0.0.1:5432:aggregator:pgsqluser:pgsqlpwd" > ~/.pgpass
+    $ chmod 700 ~/.pgpass
+    $ sudo -u postgres createuser pgsqluser --no-superuser --createdb --no-createrole
+    $ createdb aggregator --no-password
+    $ echo "ALTER USER pgsqluser WITH ENCRYPTED PASSWORD 'pgsqlpwd';" | sudo -u postgres psql
+    $ echo "GRANT ALL PRIVILEGES ON DATABASE aggregator TO pgsqluser;" | sudo -u postgres psql
+
+Edit the configuration file with the line:
+
+.. code-block:: cfg
+
+    [database]
+    uri = postgres://pgsqluser:pgsqlpwd@127.0.0.1:5433/aggregator
+
+If you want to use SQLite
+'''''''''''''''''''''''''
+
+Just edit the configuration file with the line:
+
+.. code-block:: cfg
+
+    [database]
+    uri = sqlite+pysqlite:///pyAggr3g470r.db
+
+
+Finally:
+
+.. code-block:: bash
+
+    $ python db_create.py
+    $ python runserver.py
+     * Running on http://0.0.0.0:5000/
+     * Restarting with reloader
+
+
+Configuration
+=============
+
+Configuration (database url, email, proxy, user agent, etc.) is done via the file *conf/conf.cfg*.
+Check these configuration before executing *db_create.py*.   
+If you want to use pyAggr3g470r with Tor/Privoxy, you just have to set the value of
+*http_proxy* (most of the time: *http_proxy = 127.0.0.1:8118**). Else leave the value blank.
+
+
+Automatic updates
+=================
+
+You can fetch new articles with `cron <https://en.wikipedia.org/wiki/Cron>`_  and the script *fetch.py*.
+For example if you want to check for updates every 30 minutes, add this line to your cron rules (*crontab -e*):
+
+.. code-block:: bash
+
+    */30 * * * * cd ~/.pyaggr3g470r/ ; python fetch.py firstname.lastname@mail.com
+
+You must give the email address you use to login to pyAggr3g470r.
diff --git a/documentation/index.rst b/documentation/index.rst
new file mode 100644
index 00000000..d01dc583
--- /dev/null
+++ b/documentation/index.rst
@@ -0,0 +1,34 @@
+.. pyAggr3g470r documentation master file, created by
+   sphinx-quickstart on Fri Feb 20 07:23:42 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pyAggr3g470r's documentation!
+========================================
+
+
+Deployment and configuration
+============================
+
+.. toctree::
+    :maxdepth: 2
+
+    deployment
+
+Web services
+============
+
+.. toctree::
+    :maxdepth: 2
+
+    web-services
+
+Migrations
+==========
+
+.. toctree::
+    :maxdepth: 2
+
+    migrations
+
+
diff --git a/documentation/make.bat b/documentation/make.bat
new file mode 100644
index 00000000..fa0c6a48
--- /dev/null
+++ b/documentation/make.bat
@@ -0,0 +1,190 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  texinfo    to make Texinfo files
+	echo.  gettext    to make PO message catalogs
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyAggr3g470r.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyAggr3g470r.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "texinfo" (
+	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+	goto end
+)
+
+if "%1" == "gettext" (
+	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+:end
diff --git a/documentation/migrations.rst b/documentation/migrations.rst
index f29c7a19..69f6c974 100644
--- a/documentation/migrations.rst
+++ b/documentation/migrations.rst
@@ -12,13 +12,13 @@ are used to ease remote migrations.
 Local migrations
 ----------------
 
-.. code:: bash
+.. code-block:: bash
 
     $ python manage.py db upgrade
 
 Remote migrations
 -----------------
 
-.. code:: bash
+.. code-block:: bash
 
     $ heroku run python manage.py db upgrade
diff --git a/documentation/web-services.rst b/documentation/web-services.rst
index 9c616642..2d724569 100644
--- a/documentation/web-services.rst
+++ b/documentation/web-services.rst
@@ -4,11 +4,11 @@ Web service
 Articles
 --------
 
-.. code:: python
+.. code-block:: python
 
     >>> import requests, json
     >>> r = requests.get("https://pyaggr3g470r.herokuapp.com/api/v1.0/articles", auth=("your-email", "your-password"))
-    >>> r.status_code
+    >>> r.status_code-block
     200
     >>> rjson = json.loads(r.text)
     >>> rjson["result"][0]["title"]
@@ -18,7 +18,7 @@ Articles
 
 Possible parameters:
 
-.. code:: bash
+.. code-block:: bash
 
     $ curl --user your-email:your-password "https://pyaggr3g470r.herokuapp.com/api/v1.0/articles?filter_=unread&feed=24"
     $ curl --user your-email:your-password "https://pyaggr3g470r.herokuapp.com/api/v1.0/articles?filter_=read&feed=24&limit=20"
@@ -26,13 +26,13 @@ Possible parameters:
 
 Get an article:
 
-.. code:: bash
+.. code-block:: bash
 
     $ curl --user your-email:your-password "https://pyaggr3g470r.herokuapp.com/api/v1.0/articles/84566"
 
 Add an article:
 
-.. code:: python
+.. code-block:: python
 
     >>> import requests, json
     >>> headers = {'Content-type': 'application/json', 'Accept': 'application/json'}
@@ -48,7 +48,7 @@ Add an article:
 
 Update an article:
 
-.. code:: python
+.. code-block:: python
 
     >>> payload = {"like":True, "readed":False}
     >>> r = requests.put("https://pyaggr3g470r.herokuapp.com/api/v1.0/articles/65", headers=headers, auth=("your-email", "your-password"), data=json.dumps(payload))
@@ -59,7 +59,7 @@ Update an article:
 
 Delete an article:
 
-.. code:: python
+.. code-block:: python
 
     >>> r = requests.delete("https://pyaggr3g470r.herokuapp.com/api/v1.0/articles/84574", auth=("your-email", "your-password"))
     >>> print r.status_code
@@ -81,20 +81,20 @@ Feeds
 
 Add a feed:
 
-.. code:: python
+.. code-block:: python
 
     >>> payload = {'link': 'http://blog.cedricbonhomme.org/feed'}
     >>> r = requests.post("https://pyaggr3g470r.herokuapp.com/api/v1.0/feeds", headers=headers, auth=("your-email", "your-password"), data=json.dumps(payload))
 
 Update a feed:
 
-.. code:: python
+.. code-block:: python
 
     >>> payload = {"title":"Feed new title", "description":"New description"}
     >>> r = requests.put("https://pyaggr3g470r.herokuapp.com/api/v1.0/feeds/42", headers=headers, auth=("your-email", "your-password"), data=json.dumps(payload))
 
 Delete a feed:
 
-.. code:: python
+.. code-block:: python
 
     >>> r = requests.delete("https://pyaggr3g470r.herokuapp.com/api/v1.0/feeds/29", auth=("your-email", "your-password"))