Commits

Gregory Petukhov committed 71352d5

Make docs for sphinx

Comments (0)

Files changed (6)

 update.sh
 django_urlauth.egg-info/
 dist/
+docs/_build
-How to install django-urlauth
-=============================
+==============================
+Installation of django-urlauth
+==============================
 
- * Install django-urlauth package with pip or easy_install
- * Add `urlauth` to settings.INSTALLED_APPS
- * Add `urlauth.middleware.AuthKeyMiddleware` to settings.MIDDLEWARE_CLASSES
- * Add "from urlauth.settings import *" line to settings.py
- * Do syncdb
+If you have ``easy_install`` or ``pip`` then run::
+
+    easy_install django-urlauth
+
+or
+
+    pip django-urlauth
+
+Also you can download package and run the following command iside package directory::
+
+    python setup.py install
+
+After installing django-urlauth package to the system you have to setup your site. See "index.rst" file in the "docs/" directory for site setup instructions.
-How to use django-urlauth
-=========================
+==============
+django-urlauth
+==============
 
-Django-urlauth allows you to build link which will authenticate the user which opens it. This is acheaved with special code in the querystring part of the link. Example of link http://somedomain.com/path/?authkey=SOME_KEY.
+This django application allows you to build special link. When somebody goes via that link to your site he will be automatically authenticated. THis is acheaved with special GET argumetns which is appended to the link. Such link are usually used in the emails.
 
-Usage example:
+Example of such link: http://domain.com/profile/edit/?authkey=SOME_HASH
 
->>> from urlauth.util import wrap_url
->>> wrap_url('http://domain.com/path/', uid=10)
-http://domain.com/path/?authkey=404787ca65ea256e120af7e5e3c217170b1755ad'
-
-
-Extra data
-==========
-
-It is possible to store in AuthKey instance extra data. All arguments of wrap_url function except uid and expired will be saved in the key record and will be accessible later via `extra` property.
-
-Usage example:
-
->>> from urlauth.util import wrap_url, load_key
->>> url = wrap_url('http://google.com', uid=13, foo='bar', baz=100)
->>> url
-'http://google.com?authkey=b68b4e38c0356c3eeb7a7ec6849a2dfc86902a10'
->>> hash = url.split('=')[1]
->>> key = load_key(hash)
->>> key.extra
-{u'foo': u'bar', u'baz': 100}
-
-
-Signals
-=======
-
-urlauth middleware generates two signals:
- * `key_loaded` - when AuthKey instance was found for hash in url
- * `key_processed` - when User was found for the user ID stored in the key
-
-Each signal provides key and request arguments for your handlers.
-
-
-Middleware
-==========
-
-Main function of urlauth middleware is to authenticate user. If onetime property of loaded key is True then key is not deleted and stored in the request.authkey.
+For installation insctructions see the file "INSTALL". Full documentation is available in the file "index.rst" in the "docs/" directory.
+# 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) .
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+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 "  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 "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@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."
+
+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/django-urlauth.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-urlauth.qhc"
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+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."
+# -*- coding: utf-8 -*-
+#
+# django-urlauth documentation build configuration file, created by
+# sphinx-quickstart on Sat Jan  2 01:45:43 2010.
+#
+# 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.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# 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'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'django-urlauth'
+copyright = u'2010, Grigoriy Petukhov'
+
+# 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 = '0.1.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.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 documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_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.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+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_use_modindex = 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, 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 = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'django-urlauthdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'django-urlauth.tex', u'django-urlauth Documentation',
+   u'Grigoriy Petukhov', '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
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+.. django-urlauth documentation master file, created by
+   sphinx-quickstart on Sat Jan  2 01:45:43 2010.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+django-urlauth overview
+=======================
+
+This django application allows you to build special link. When somebody goes via such link to your site he will be automatically authenticated. This is acheaved with special GET arguments which is appended to the link. Such link are usually used in the emails.
+
+Example of such link: http://domain.com/profile/edit/?authkey=SOME_HASH
+
+Simplest example of using django-urlauth::
+
+    >>> from urlauth.util import wrap_url
+    >>> wrap_url('http://domain.com/path/', uid=10)
+    http://domain.com/path/?authkey=404787ca65ea256e120af7e5e3c217170b1755ad'
+
+
+Project setup
+=============
+
+After install django-urlauth package you have to setup your django project.
+
+* Add ``urlauth`` to ``settings.INSTALLED_APPS``
+* Add ``urlauth.middleware.AuthKeyMiddleware`` to ``settings.MIDDLEWARE_CLASSES``
+* Add ``from urlauth.settings import *`` line to settings.py
+* Do syncdb
+
+
+Extra data
+==========
+
+It is possible to store extra data in ``AuthKey`` instance. All arguments of ``wrap_url`` function except ``uid``, ``expired`` and ``onetime`` will be saved in the key instance and will be accessible later via ``extra`` property.
+
+Example of using extra data::
+
+    >>> from urlauth.util import wrap_url, load_key
+    >>> url = wrap_url('http://google.com', uid=13, foo='bar', baz=100)
+    >>> url
+    'http://google.com?authkey=b68b4e38c0356c3eeb7a7ec6849a2dfc86902a10'
+    >>> hash = url.split('=')[1]
+    >>> key = load_key(hash)
+    >>> key.extra
+    {u'foo': u'bar', u'baz': 100}
+
+
+Middleware
+==========
+
+Main function of ``urlauth.middleware.AuthKeyMiddleware`` is to authenticate user. If ``onetime`` property of loaded key is ``True`` then that key is not deleted and stored in the ``request.authkey`` attribute. Keys with false``onetime`` property are deleted immediatelly after processing.
+
+
+Signals
+=======
+
+``urlauth.middleware.AuthKeyMiddleware`` generates two signals:
+ * ``key_loaded`` - when ``AuthKey`` instance was found for hash in url
+ * ``key_processed`` - when ``User`` was found for the user ID stored in the key
+
+Each signal provides ``key`` and ``request`` arguments for your handlers.
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+