Commits

Andy Mikhailenko committed ed5d820

Fixed the breadcrumb decorator: now using functools.wrapper. Added documentation (incomplete and inaccurate but at least giving the idea of what is all this for).

  • Participants
  • Parent commits fe2cb41

Comments (0)

Files changed (8)

+# 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 singlehtml pickle json htmlhelp qthelp epub 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 "  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 "  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/django-navigation.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-navigation.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/django-navigation"
+	@echo "# ln -s _build/devhelp $$HOME/.local/share/devhelp/django-navigation"
+	@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 all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+latexpdf: latex
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C _build/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in _build/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-navigation documentation build configuration file, created by
+# sphinx-quickstart on Sun Oct  3 10:26:37 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
+
+from django.conf import settings
+settings.configure()
+
+import navigation
+
+
+# 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 -----------------------------------------------------
+
+# 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']
+
+# 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'django-navigation'
+copyright = u'2010, Andrey Mikhaylenko'
+
+# 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 = '.'.join(navigation.__version__.split('.')[:2])
+# The full version, including alpha/beta/rc tags.
+release = navigation.__version__
+
+# 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.  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, "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 = ''
+
+# 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-navigationdoc'
+
+
+# -- 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-navigation.tex', u'django-navigation Documentation',
+   u'Andrey Mikhaylenko', '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
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+#epub_title = ''
+#epub_author = ''
+#epub_publisher = ''
+#epub_copyright = ''
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+.. django-navigation documentation master file, created by
+   sphinx-quickstart on Sun Oct  3 10:26:37 2010.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Django-Navigation
+=================
+
+A breadcrumbs navigation application for Django framework.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+   glossary
+
+Main idea
+=========
+
+Let's assume we have this URL path::
+
+    /news/2010/oct/hello-world/
+
+We need to convert it to :term:`breadcrumbs` and display along the heading this
+way::
+
+    News → 2010 news → October 2010
+
+So we just type this in our template::
+
+    <ul>
+    {% for crumb in request|get_trail %}
+        <li><a href="{{ crumb.url }}">{{ crumb }}</a></li>
+    {% endfor %}
+    </ul>
+    <h1>{{ request|get_section }}
+
+...and this is the result::
+
+    <ul>
+        <li><a href="/news/>News</li>
+        <li><a href="/news/2010/">2010 news</li>
+        <li><a href="/news/2010/oct/">October 2010</a></li>
+    </ul>
+    <h1>Hello world</h1>
+
+How does this work?
+-------------------
+
+Current URL path is split into hierarchical parts::
+
+    * /news/
+    * /news/2010/
+    * /news/2010/oct/
+    * /news/2010/oct/hello-world/
+
+For each part a :class:`navigation.helpers.Crumb` instance is created. It
+stores the URL and the corresponding title. But how do we know the title?
+
+The URL title is resolved by a :term:`crumb resolver`. By default two resolvers
+are available: `_resolve_flatpage` and `_resolve_by_callback`.
+
+The first one looks for a `FlatPage` object with given URL path in the database
+(if `django.contrib.flatpages` is activated in settings). If this resolver
+failed (i.e. flatpages are not available or there's no `FlatPage` with such URL
+path), then next crumb resolver is called.
+
+The crumb resolver `_resolve_by_callback` peeks into the URL maps and attempts
+to resolve the URL into a view function. If such function is found, the
+resolver looks whether the function has the "breadcrumb" attribute. This
+attribute can be set by wrapping the view in decorator
+:func:`navigation.decorators.breadcrumb`::
+
+    from navigation.decorators import breadcrumb
+
+    @breadcrumb('Hello')
+    def say_hello(request):
+        ...
+
+    @breadcrumb(lambda request: u'%s settings' % request.user)
+    def user_settings(request):
+        ...
+
+If the attribute is not found, we can't guess the name and give up. A dummy
+breadcrumb is add to the trail.
+
+However, we could also try "humanizing" the function's ``__name__`` attribute
+or use a custom path-to-name mapping. You can do that easily by creating your
+own crumb resolvers and registering them this way::
+
+    from navigation.resolvers import crumb_resolver
+
+    @crumb_resolver
+    def my_custom_resolver_function(request, url):
+        return Crumb(url, 'Hello!')
+
+.. topic:: TODO
+
+    Make this more explicit, e.g. add a settings variable like this::
+
+        NAVIGATION_RESOLVERS = [
+            'navigation.resolvers.resolve_flatpage',
+            'navigation.resolvers.resolve_by_callback',
+            'utils.navigation.my_custom_resolver_function',
+        ]
+
+History
+=======
+
+Universal breadcrumbs navigation for Django.
+
+FlatPages trail by:
+    jca <http://djangosnippets.org/snippets/519/>
+Original idea and implementation of universal breadcrumbs for custom views by:
+    Thomas Guettler <http://groups.google.com/group/django-users/browse_thread/thread/f40f59e39cef59c4>
+Unified extensible templated breadcrumbs for both FlatPages and custom views by:
+    Andrey Mikhaylenko <http://neithere.net>, <andy@neithere.net>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

navigation/__init__.py

 __author__  = 'Andy Mikhailenko'
 __license__ = 'GNU Lesser General Public License (GPL), Version 3'
 __url__     = 'http://bitbucket.org/neithere/django-navigation/'
-__version__ = '0.5.2'
+__version__ = '0.5.3'

navigation/decorators.py

 #  General Public License version 3 (LGPLv3) as published by the Free
 #  Software Foundation. See the file README for copying conditions.
 #
+"""
+Decorators
+==========
+"""
+from functools import wraps
+
+__all__ = ['breadcrumb']
+
 
 def breadcrumb(crumb):
     """
         @breadcrumb(lambda request: 'greeting for %s' % request.user.username)
         def some_view(request):
             return 'Hello %s!' % request.user.username
+
     """
     def wrapper(view):
+        @wraps(view)
         def inner(request, *args, **kwargs):
             return view(request, *args, **kwargs)
-        inner.__dict__ = dict(view.__dict__, breadcrumb=crumb)
-        inner.__name__ = view.__name__
+        inner.breadcrumb = crumb
         return inner
     return wrapper

navigation/helpers.py

 # -*- coding: utf-8 -*-
+"""
+Helpers
+=======
+"""
+class Crumb(object):
+    """ A navigation node.
 
-class Crumb(object):
-    "A navigation node."
+    .. attribute:: url
+
+        this breadcrumb's URL.
+
+    .. attribute:: title
+
+        this breadcrumb's title, as determined by the first successful
+        :term:`crumb resolver`.
+
+    .. attribute:: is_current
+
+        `True` if this breadcrumb's URL corresponds to the current request
+        path.
+
+    .. attribute:: is_dummy
+
+        `True` if this breadcrumb is a stub, i.e. its URL could not be resolved
+        by a :term:`crumb resolver`.
+
+    """
     def __init__(self, url, title, is_current=False, is_dummy=False):
         self.url        = url
         self.title      = title

navigation/templatetags/navigation_tags.py

 # -*- coding: utf-8 -*-
+"""
+Template tags and filters
+=========================
+
+Loading::
+
+    {% load navigation_tags %}
 
 """
-Universal breadcrumbs navigation for Django.
 
-FlatPages trail by:
-jca <http://djangosnippets.org/snippets/519/>
-
-Original idea and implementation of universal breadcrumbs for custom views by:
-Thomas Guettler <http://groups.google.com/group/django-users/browse_thread/thread/f40f59e39cef59c4>
-
-Unified extensible templated breadcrumbs for both FlatPages and custom views by:
-Andrey Mikhaylenko <http://neithere.net>, <andy@neithere.net>
-"""
+__all__ = ['get_sections', 'get_trail', 'get_navigation']
 
 # TODO: tags instead of filters
 
 
 @register.filter
 def get_title(request):
+    """ Returns current page's title. """
     return find_crumb(request)
 
 @register.filter
 def get_sections(request):
+    """ Returns a list of :term:`sections`. """
     return _get_sections(request)
 
 @register.filter
 def get_trail(request, exclude_section=False):
+    """ Returns the trail of :term:`breadcrumbs`. Each breadcrumb is
+    represented by a :class:`navigation.helpers.Crumb` instance.
+    """
     return _get_trail(request, exclude_section)
 
 @register.filter
 def get_navigation(request):
+    """ Returns the rendered navigation block. Requires that the
+    `navigation.html` template exists. Two context variables are passed to it:
+
+    * sections (see :func:`get_sections`)
+    * trail (see :func:`get_trail`)
+
+    """
     sections = _get_sections(request)
     trail = _get_trail(request, exclude_section=True)
 
+[upload_sphinx]
+upload-dir = build/sphinx/html