From 234bc9f96369e633999c3a07e87fafcae3ebfdb3 Mon Sep 17 00:00:00 2001 From: Corey Oordt Date: Thu, 12 Jul 2012 19:31:27 -0400 Subject: [PATCH] Updated and rendered docs --- doc_src/index.rst | 20 ++------ docs/_sources/custom_categories.txt | 2 +- docs/_sources/index.txt | 20 ++------ docs/_static/basic.css | 5 +- docs/_static/doctools.js | 2 +- docs/_static/searchtools.js | 2 +- docs/_static/sidebar.js | 2 +- docs/adding_the_fields.html | 10 ++-- docs/custom_categories.html | 44 +++++++++-------- docs/genindex.html | 62 ++++++++++++------------ docs/getting_started.html | 10 ++-- docs/index.html | 41 ++++++---------- docs/installation.html | 14 +++--- docs/objects.inv | Bin 986 -> 982 bytes docs/reference/index.html | 10 ++-- docs/reference/management_commands.html | 10 ++-- docs/reference/models.html | 10 ++-- docs/reference/settings.html | 10 ++-- docs/reference/templatetags.html | 14 +++--- docs/registering_models.html | 10 ++-- docs/search.html | 10 ++-- docs/searchindex.js | 2 +- docs/usage.html | 18 +++---- 23 files changed, 151 insertions(+), 177 deletions(-) diff --git a/doc_src/index.rst b/doc_src/index.rst index 486bae9..33705cd 100644 --- a/doc_src/index.rst +++ b/doc_src/index.rst @@ -6,27 +6,17 @@ Django Categories grew out of our need to provide a basic hierarchical taxonomy As a news site, our stories, photos, and other content get divided into "sections" and we wanted all the apps to use the same set of sections. As our needs grew, the Django Categories grew in the functionality it gave to category handling within web pages. -New in 1.0 +New in 1.1 ========== -**Abstract Base Class for generic hierarchical category models** - When you want a multiple types of categories and don't want them all part of the same model, you can now easily create new models by subclassing ``CategoryBase``. You can also add additional metadata as necessary. - - Your model's can subclass ``CategoryBaseAdminForm`` and ``CategoryBaseAdmin`` to get the hierarchical management in the admin. - - See the docs for more information. +* Fixed a cosmetic bug in the Django 1.4 admin. Action checkboxes now only appear once. -**Increased the default caching time on views** - The default setting for ``CACHE_VIEW_LENGTH`` was ``0``, which means it would tell the browser to *never* cache the page. It is now ``600``, which is the default for `CACHE_MIDDLEWARE_SECONDS `_ +* Template tags are refactored to allow easy use of any model derived from ``CategoryBase``. -**Updated for use with Django-MPTT 0.5** - Just a few tweaks. +* Improved test suite. -**Initial compatibility with Django 1.4** - More is coming, but at least it works. +* Improved some of the documentation. -**Slug transliteration for non-ASCII characters** - A new setting, ``SLUG_TRANSLITERATOR``, allows you to specify a function for converting the non-ASCII characters to ASCII characters before the slugification. Works great with `Unidecode `_. Contents diff --git a/docs/_sources/custom_categories.txt b/docs/_sources/custom_categories.txt index bfd9de4..f4ce71e 100644 --- a/docs/_sources/custom_categories.txt +++ b/docs/_sources/custom_categories.txt @@ -18,7 +18,7 @@ For many cases, you want a simple user-managed lookup table. You can do this wit #. Create a subclass of CategoryBaseAdmin. - .. literalinclude:: code_examples/custom_categories1.py + .. literalinclude:: code_examples/custom_categories2.py :linenos: #. Register your model and custom model admin class. diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt index 486bae9..33705cd 100644 --- a/docs/_sources/index.txt +++ b/docs/_sources/index.txt @@ -6,27 +6,17 @@ Django Categories grew out of our need to provide a basic hierarchical taxonomy As a news site, our stories, photos, and other content get divided into "sections" and we wanted all the apps to use the same set of sections. As our needs grew, the Django Categories grew in the functionality it gave to category handling within web pages. -New in 1.0 +New in 1.1 ========== -**Abstract Base Class for generic hierarchical category models** - When you want a multiple types of categories and don't want them all part of the same model, you can now easily create new models by subclassing ``CategoryBase``. You can also add additional metadata as necessary. - - Your model's can subclass ``CategoryBaseAdminForm`` and ``CategoryBaseAdmin`` to get the hierarchical management in the admin. - - See the docs for more information. +* Fixed a cosmetic bug in the Django 1.4 admin. Action checkboxes now only appear once. -**Increased the default caching time on views** - The default setting for ``CACHE_VIEW_LENGTH`` was ``0``, which means it would tell the browser to *never* cache the page. It is now ``600``, which is the default for `CACHE_MIDDLEWARE_SECONDS `_ +* Template tags are refactored to allow easy use of any model derived from ``CategoryBase``. -**Updated for use with Django-MPTT 0.5** - Just a few tweaks. +* Improved test suite. -**Initial compatibility with Django 1.4** - More is coming, but at least it works. +* Improved some of the documentation. -**Slug transliteration for non-ASCII characters** - A new setting, ``SLUG_TRANSLITERATOR``, allows you to specify a function for converting the non-ASCII characters to ASCII characters before the slugification. Works great with `Unidecode `_. Contents diff --git a/docs/_static/basic.css b/docs/_static/basic.css index 925f7a5..32630d5 100644 --- a/docs/_static/basic.css +++ b/docs/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -413,7 +413,7 @@ dl.glossary dt { } .footnote:target { - background-color: #ffa + background-color: #ffa; } .line-block { @@ -444,6 +444,7 @@ dl.glossary dt { pre { overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ } td.linenos pre { diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js index eeea95e..8b9bd2c 100644 --- a/docs/_static/doctools.js +++ b/docs/_static/doctools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilties for all documentation. * - * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js index 5cbfe00..dae92b5 100644 --- a/docs/_static/searchtools.js +++ b/docs/_static/searchtools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilties for the full-text search. * - * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/docs/_static/sidebar.js b/docs/_static/sidebar.js index 7318517..e9ef491 100644 --- a/docs/_static/sidebar.js +++ b/docs/_static/sidebar.js @@ -16,7 +16,7 @@ * Once the browser is closed the cookie is deleted and the position * reset to the default (expanded). * - * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/docs/adding_the_fields.html b/docs/adding_the_fields.html index c8646c6..4645f60 100644 --- a/docs/adding_the_fields.html +++ b/docs/adding_the_fields.html @@ -6,13 +6,13 @@ - Adding the fields to the database — Django Categories v1.0.5 documentation + Adding the fields to the database — Django Categories v1.1 documentation - +
-

Django Categories v1.0.5 documentation

+

Django Categories v1.1 documentation