diff --git a/.gitignore b/.gitignore index 0fec171..3a3db0d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ *.pyc django_taggit.egg-info/ -dist/ \ No newline at end of file +dist/ +_build/ diff --git a/README.txt b/README.txt index 9107941..bad7881 100644 --- a/README.txt +++ b/README.txt @@ -28,28 +28,6 @@ Then you can use the API like so:: Tags will show up for you automatically in forms and the admin. -If you don't like the inefficiency of generic foreign keys, and you -know in advance which models in your project will be tagged, -django-taggit also supports tagging with direct foreign keys. You must -create your own intermediary model, a subclass of -``taggit.models.TaggedItemBase`` with a foreign key to your content -model named ``content_object``, and then pass this intermediary model -as the ``through`` argument of ``TaggableManager``:: - - from django.db import models - - from taggit.managers import TaggableManager - from taggit.models import TaggedItemBase - - class TaggedFood(TaggedItemBase): - content_object = models.ForeignKey('Food') - - class Food(models.Model): - # ... fields here - - tags = TaggableManager(through=TaggedFood) - -Once this is done, the API works identically with direct-tagged or -GFK-tagged models. - ``django-taggit`` requires Django 1.1 or greater. + +For more info checkout out the documentation. diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..3374c0a --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,89 @@ +# 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-taggit.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-taggit.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." diff --git a/docs/api.txt b/docs/api.txt new file mode 100644 index 0000000..bf806f8 --- /dev/null +++ b/docs/api.txt @@ -0,0 +1,43 @@ +The API +======= + +After you've got your ``TaggableManager`` added to your model you can start +playing around with the API. + + +add(*tags) +~~~~~~~~~~ + +This adds tags to an object, the tags can be either ``Tag`` instances, or +strings:: + + >>> apple.tags.all() + [] + >>> apple.tags.add("red", "green", "fruit") + + +remove(*tags) +~~~~~~~~~~~~~ + +Removes a tag from an object, no exception is raised if the object doesn't have +that tag. + +clear() +~~~~~~~ + +Removes all tags from an object. + +set(*tags) +~~~~~~~~~~ + +Removes all the current tags and then adds the specified tags to the object. + +most_common() +~~~~~~~~~~~~~ + +Returns a ``QuerySet`` of all tags, annotated with the number of times they +appear, available as the ``num_times`` attribute on each tag. The ``QuerySet`` +is ordered by ``num_times``, descending. The ``QuerySet`` is lazily evaluated, +and can be sliced efficiently. + + diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..798f348 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,198 @@ +# -*- coding: utf-8 -*- +# +# django-taggit documentation build configuration file, created by +# sphinx-quickstart on Mon May 3 22:22:47 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 = ['sphinx.ext.intersphinx'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.txt' + +# The encoding of source files. +#source_encoding = 'utf-8' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'django-taggit' +copyright = u'2010, Alex Gaynor' + +# 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.4' +# The full version, including alpha/beta/rc tags. +release = '0.4' + +# 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-taggitdoc' + + +# -- 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-taggit.tex', u'django-taggit Documentation', + u'Alex Gaynor', '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 + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/docs/custom_through.txt b/docs/custom_through.txt new file mode 100644 index 0000000..b4ec944 --- /dev/null +++ b/docs/custom_through.txt @@ -0,0 +1,31 @@ +Using a Custom Through Model +============================ + +By default ``django-taggit`` uses a "through model" with a ``GenericForeignKey`` +on it. However, there are some cases where this isn't desirable, for example +if you want the speed and referential guarntees of a real ``ForeignKey``, or if +you have a model with a non-integer primary key. In these cases ``django-taggit`` +makes it easy to subsistute your own through model. + +You must create your own intermediary model, a subclass of +``taggit.models.TaggedItemBase`` with a foreign key to your content model named +``content_object``, and then pass this intermediary model as the ``through`` +argument of ``TaggableManager``:: + + from django.db import models + + from taggit.managers import TaggableManager + from taggit.models import TaggedItemBase + + + class TaggedFood(TaggedItemBase): + content_object = models.ForeignKey('Food') + + class Food(models.Model): + # ... fields here + + tags = TaggableManager(through=TaggedFood) + + +Once this is done, the API works identically with direct-tagged or +GFK-tagged models. diff --git a/docs/getting_started.txt b/docs/getting_started.txt new file mode 100644 index 0000000..0c88802 --- /dev/null +++ b/docs/getting_started.txt @@ -0,0 +1,23 @@ +Getting Started +=============== + +To get started using ``django-taggit`` simply install it ``pip``:: + + $ pip install django-taggit + + +Add it to your project's ``INSTALLED_APPS`` setting. + +And then to any model you want tagging on do the following:: + + from django.db import models + + from taggit.managers import TaggableManager + + class Food(models.Model): + # ... fields here + + tags = TaggableManager() + + + diff --git a/docs/index.txt b/docs/index.txt new file mode 100644 index 0000000..f4cbd0d --- /dev/null +++ b/docs/index.txt @@ -0,0 +1,20 @@ +Welcome to django-taggit's documentation! +========================================= + +``django-taggit`` is a reusable Django application designed to making adding +tagging to your project easy and fun. + +.. toctree:: + :maxdepth: 2 + + getting_started + api + custom_through + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` +