Permalink
Browse files

Update docs

Moved and updated CHANGELOG to be a part of the
documentation. Also, updated the settings docs
to include missing settings that were previously
undocumented.
  • Loading branch information...
1 parent edbf6a0 commit bbd5a56072c17b4c66652c91216e31f9034b3e21 @paltman paltman committed Jan 14, 2013
Showing with 95 additions and 246 deletions.
  1. +0 −32 CHANGELOG
  2. +40 −0 docs/changelog.rst
  3. +16 −204 docs/conf.py
  4. +2 −0 docs/index.rst
  5. +33 −7 docs/settings.rst
  6. +4 −3 docs/usage.rst
View
@@ -1,32 +0,0 @@
-BI = backward incompatible change
-
-1.0
----
-
-
-
-0.3
----
-
- * pluggable backends
-
-0.2.0
------
-
- * BI: renamed Notice.user to Notice.recipient
- * BI: renamed {{ user }} context variable in notification templates to
- {{ recipient }}
- * BI: added nullable Notice.sender and modified send_now and queue to take
- an optional sender
- * added received and sent methods taking a User instance to Notice.objects
- * New default behavior: single notice view now marks unseen notices as seen
- * no longer optionally depend on mailer; use django.core.mail.send_mail and
- we now encourge use of Django 1.2+ for mailer support
- * notifications are not sent to inactive users
- * users which do not exist when sending notification are now ignored
- * BI: split settings part of notices view to its own view notice_settings
-
-0.1.5
------
-
- * added support for DEFAULT_HTTP_PROTOCOL allowing https absolute URLs
View
@@ -0,0 +1,40 @@
+.. _changelog:
+
+ChangeLog
+=========
+
+BI = backward incompatible change
+
+1.0
+---
+
+* removed unused `message.py` module
+* removed `captureas` templatetag
+* added `notice_settings.html` template
+* other minor fixes and tweaks, mostly to code style
+
+0.3
+---
+
+* pluggable backends
+
+0.2.0
+-----
+
+* BI: renamed Notice.user to Notice.recipient
+* BI: renamed {{ user }} context variable in notification templates to
+ {{ recipient }}
+* BI: added nullable Notice.sender and modified send_now and queue to take
+ an optional sender
+* added received and sent methods taking a User instance to Notice.objects
+* New default behavior: single notice view now marks unseen notices as seen
+* no longer optionally depend on mailer; use django.core.mail.send_mail and
+ we now encourge use of Django 1.2+ for mailer support
+* notifications are not sent to inactive users
+* users which do not exist when sending notification are now ignored
+* BI: split settings part of notices view to its own view notice_settings
+
+0.1.5
+-----
+
+* added support for DEFAULT_HTTP_PROTOCOL allowing https absolute URLs
View
@@ -1,216 +1,28 @@
-# -*- coding: utf-8 -*-
-#
-# django-notification documentation build configuration file, created by
-# sphinx-quickstart on Thu Jun 30 13:22:02 2011.
-#
-# 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 = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
+extensions = []
+templates_path = []
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'django-notification'
-copyright = u'2011, James Tauber and contributors'
-
-# 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.2'
-# The full version, including alpha/beta/rc tags.
-release = '0.2.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.
+package = 'notification'
+copyright_holder = 'Eldarion'
+copyright = u'2013, %s' % copyright_holder
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 = 'django-notificationdoc'
-
-
-# -- 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]).
+htmlhelp_basename = '%sdoc' % project
latex_documents = [
- ('index', 'django-notification.tex', u'django-notification Documentation',
- u'James Tauber and contributors', 'manual'),
+ ('index', '%s.tex' % project, u'%s Documentation' % project,
+ copyright_holder, '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
-
-# 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_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', 'django-notification', u'django-notification Documentation',
- [u'James Tauber and contributors'], 1)
+ ('index', project, u'%s Documentation' % project,
+ [copyright_holder], 1)
]
+
+sys.path.insert(0, os.pardir)
+m = __import__(package)
+
+version = m.__version__
+release = version
View
@@ -24,6 +24,8 @@ Contents:
usage
settings
+ changelog
+
Indices and tables
==================
Oops, something went wrong.

0 comments on commit bbd5a56

Please sign in to comment.