From ce2a691497c219a3b9a325696e1bd649d967cab8 Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Thu, 16 Jan 2014 12:34:30 +0100 Subject: [PATCH] fixed some documentation and other minor issues. --- INSTALL.txt | 15 --------------- LICENSE.txt | 2 +- MANIFEST.in | 1 - docs/conf.py | 2 +- docs/index.txt | 25 ++++++++++++++++++------- setup.py | 2 +- 6 files changed, 21 insertions(+), 26 deletions(-) delete mode 100644 INSTALL.txt diff --git a/INSTALL.txt b/INSTALL.txt deleted file mode 100644 index 0d6eb48..0000000 --- a/INSTALL.txt +++ /dev/null @@ -1,15 +0,0 @@ -To install it, run the following command inside this directory: - - python setup.py install - -Or if you'd prefer you can simply place the included ``robots`` -directory somewhere on your Python path, or symlink to it from -somewhere on your Python path; this is useful if you're working from a -Subversion checkout. - -Note that this application requires Python 2.3 or later, and a recent -Subversion checkout of Django. You can obtain Python from -http://www.python.org/ and Django from http://www.djangoproject.com/. - -This install notice was bluntly stolen from James Bennett's registration -package. \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt index 2412afc..8de5fb4 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,4 +1,4 @@ -Copyright (c) 2008-2012, Jannis Leidel +Copyright (c) 2008-2014, Jannis Leidel All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/MANIFEST.in b/MANIFEST.in index bba4b82..2a8ba7b 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,3 @@ -include INSTALL.txt include LICENSE.txt include MANIFEST.in include README.rst diff --git a/docs/conf.py b/docs/conf.py index 1eb05e6..190f1c6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,7 +41,7 @@ # General information about the project. project = u'django-robots' -copyright = u'2012, Jannis Leidel' +copyright = u'2008-2014, Jannis Leidel' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/docs/index.txt b/docs/index.txt index 2953138..3b24259 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -16,18 +16,21 @@ tied together with a m2m relationship: Installation ============ -Get the source from the application site at:: +Use your favorite Python installer to install it from PyPI:: + + pip install django-robots + +Or get the source from the application site at:: http://github.com/jezdez/django-robots/ -To install the sitemap app, follow these steps: +To install the sitemap app, then follow these steps: -1. Follow the instructions in the INSTALL.txt file -2. Add ``'robots'`` to your INSTALLED_APPS_ setting. -3. Make sure ``'django.template.loaders.app_directories.load_template_source'`` +1. Add ``'robots'`` to your INSTALLED_APPS_ setting. +2. Make sure ``'django.template.loaders.app_directories.Loader'`` is in your TEMPLATE_LOADERS_ setting. It's in there by default, so you'll only need to change this if you've changed that setting. -4. Make sure you've installed the `sites framework`_. +3. Make sure you've installed the `sites framework`_. .. _INSTALLED_APPS: http://docs.djangoproject.com/en/dev/ref/settings/#installed-apps .. _TEMPLATE_LOADERS: http://docs.djangoproject.com/en/dev/ref/settings/#template-loaders @@ -36,7 +39,7 @@ To install the sitemap app, follow these steps: Sitemaps -------- -By default a ``Sitemap`` statement is automatically added to the resulting +By default a ``Sitemap`` statement is automatically added to the resulting robots.txt by reverse matching the URL of the installed `Sitemap contrib app`_. This is especially useful if you allow every robot to access your whole site, since it then gets URLs explicitly instead of searching every link. @@ -125,6 +128,14 @@ The default value is ``None`` (no caching). Changelog ========= +1.0 (01/16/2014) +---------------- + +- *BACKWARDS-INCOMPATIBLE* change: The default behaviour of this app has + changed to **allow all bots** from the previous opposite behavior. + +- Fixed some backward compatibility issues. + 0.9.2 (03/24/2013) ------------------ diff --git a/setup.py b/setup.py index f6042ea..6d0858d 100644 --- a/setup.py +++ b/setup.py @@ -33,7 +33,7 @@ def find_version(*file_paths): ], }, classifiers=[ - 'Development Status :: 4 - Beta', + 'Development Status :: 5 - Production/Stable', 'Environment :: Web Environment', 'Intended Audience :: Developers', 'License :: OSI Approved :: BSD License',