Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fixed several broken and redirecting URLs in the documentation (fixes…

… #12219, refs #12427).

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit adb74a8f2eaa3854ff59da30d2261a18415327cc 1 parent 66ef91d
Gary Wilson Jr. gdub authored
2  docs/faq/install.txt
@@ -35,7 +35,7 @@ also need a database engine. PostgreSQL_ is recommended, because we're
PostgreSQL fans, and MySQL_, `SQLite 3`_, and Oracle_ are also supported.
.. _Python:
-.. _WSGI:
+.. _WSGI:
.. _server arrangements wiki page:
.. _PostgreSQL:
.. _MySQL:
2  docs/howto/auth-remote-user.txt
@@ -12,7 +12,7 @@ Windows Authentication or Apache and `mod_authnz_ldap`_, `CAS`_, `Cosign`_,
`WebAuth`_, `mod_auth_sspi`_, etc.
.. _mod_authnz_ldap:
-.. _CAS:
+.. _CAS:
.. _Cosign:
.. _WebAuth:
.. _mod_auth_sspi:
4 docs/howto/deployment/modpython.txt
@@ -375,9 +375,9 @@ set of imports until it stops crashing, so as to find the specific module that
causes the problem. Drop down further into modules and look into their imports,
as necessary.
-.. _Expat Causing Apache Crash:
+.. _Expat Causing Apache Crash:
.. _mod_python FAQ entry:
-.. _Getting mod_python Working:
+.. _Getting mod_python Working:
If you get a UnicodeEncodeError
10 docs/howto/outputting-pdf.txt
@@ -16,13 +16,13 @@ For example, Django was used at kusports.com_ to generate customized,
printer-friendly NCAA tournament brackets, as PDF files, for people
participating in a March Madness contest.
-.. _ReportLab:
+.. _ReportLab:
Install ReportLab
-Download and install the ReportLab library from
+Download and install the ReportLab library from
The `user guide`_ (not coincidentally, a PDF file) explains how to install it.
Test your installation by importing it in the Python interactive interpreter::
@@ -138,17 +138,15 @@ Further resources
* PDFlib_ is another PDF-generation library that has Python bindings. To
use it with Django, just use the same concepts explained in this article.
- * `Pisa HTML2PDF`_ is yet another PDF-generation library. Pisa ships with
+ * `Pisa XHTML2PDF`_ is yet another PDF-generation library. Pisa ships with
an example of how to integrate Pisa with Django.
* HTMLdoc_ is a command-line script that can convert HTML to PDF. It
doesn't have a Python interface, but you can escape out to the shell
using ``system`` or ``popen`` and retrieve the output in Python.
- * `forge_fdf in Python`_ is a library that fills in PDF forms.
.. _PDFlib:
-.. _`Pisa HTML2PDF`:
+.. _`Pisa XHTML2PDF`:
.. _HTMLdoc:
-.. _forge_fdf in Python:
Other formats
15 docs/internals/contributing.txt
@@ -849,7 +849,8 @@ dependencies:
* Textile_
* Docutils_
* setuptools_
- * memcached_, plus the either the python-memcached_ or cmemcached_ Python binding
+ * memcached_, plus the either the python-memcached_ or cmemcached_
+ Python binding
If you want to test the memcached cache backend, you will also need to define
a :setting:`CACHE_BACKEND` setting that points at your memcached instance.
@@ -864,7 +865,7 @@ associated tests will be skipped.
.. _setuptools:
.. _memcached:
.. _python-memcached:
-.. _cmemcached:
+.. _cmemcached:
To run a subset of the unit tests, append the names of the test modules to the
```` command line. See the list of directories in
@@ -959,9 +960,9 @@ for feature branches:
If you want a feature branch in SVN, you'll need to ask in
`django-developers`_ for a mentor.
-.. _git:
-.. _mercurial:
-.. _bazaar:
+.. _git:
+.. _mercurial:
+.. _bazaar:
.. _django branches:
Branch rules
@@ -1093,7 +1094,7 @@ If you're using Django 0.95 or earlier and installed it using
file. Then copy the branch's version of the ``django`` directory into
-.. _path file:
+.. _path file:
Deciding on features
@@ -1159,6 +1160,6 @@ requests for commit access are potential flame-war starters, and will be ignored
.. _django-users:
.. _`#django`: irc://
.. _list of tickets with patches:
.. _i18n branch:
.. _`tags/releases`:
2  docs/internals/documentation.txt
@@ -10,7 +10,7 @@ based on docutils__. The basic idea is that lightly-formatted plain-text
documentation is transformed into HTML, PDF, and any other output format.
To actually build the documentation locally, you'll currently need to install
Sphinx -- ``easy_install Sphinx`` should do the trick.
4 docs/intro/tutorial01.txt
@@ -102,7 +102,7 @@ These files are:
contents" of your Django-powered site. You can read more about URLs in
-.. _more about packages:
+.. _more about packages:
The development server
@@ -367,7 +367,7 @@ Finally, note a relationship is defined, using
to a single Poll. Django supports all the common database relationships:
many-to-ones, many-to-manys and one-to-ones.
-.. _`Python path`:
+.. _`Python path`:
Activating models
1  docs/ref/contrib/flatpages.txt
@@ -26,7 +26,6 @@ content in a custom template.
Here are some examples of flatpages on Django-powered sites:
- *
2  docs/ref/contrib/index.txt
@@ -19,7 +19,7 @@ those packages have.
``'django.contrib.admin'``) to your ``INSTALLED_APPS`` setting and re-run
`` syncdb``.
-.. _"batteries included" philosophy:
+.. _"batteries included" philosophy:
.. toctree::
:maxdepth: 1
10 docs/ref/contrib/localflavor.txt
@@ -168,7 +168,7 @@ Austria (``at``)
.. class:: at.forms.ATStateSelect
- A ``Select`` widget that uses a list of Austrian states as its choices.
+ A ``Select`` widget that uses a list of Austrian states as its choices.
.. class:: at.forms.ATSocialSecurityNumberField
@@ -518,7 +518,7 @@ Romania (``ro``)
.. class:: ro.forms.ROIBANField
- A form field that validates its input as a Romanian International Bank
+ A form field that validates its input as a Romanian International Bank
Account Number (IBAN). The valid format is ROXX-XXXX-XXXX-XXXX-XXXX-XXXX,
with or without hyphens.
@@ -634,7 +634,7 @@ Sweden (``se``)
A \+ indicates that the person is older than 100 years, which will be taken
into consideration when the date is validated.
The checksum will be calculated and checked. The birth date is checked
to be a valid date.
@@ -650,7 +650,7 @@ Sweden (``se``)
Valid codes consist of five digits (XXXXX). The number can optionally be
formatted with a space after the third digit (XXX XX).
- The cleaned value will never contain the space.
+ The cleaned value will never contain the space.
Switzerland (``ch``)
@@ -683,7 +683,7 @@ United Kingdom (``uk``)
A form field that validates input as a UK postcode. The regular
expression used is sourced from the schema for British Standard BS7666
- address types at
+ address types at
.. class:: uk.forms.UKCountySelect
2  docs/ref/contrib/syndication.txt
@@ -940,7 +940,7 @@ attributes. Thus, you can subclass the appropriate feed generator class
(``Atom1Feed`` or ``Rss201rev2Feed``) and extend these callbacks. They are:
.. _georss:
-.. _itunes podcast format:
+.. _itunes podcast format:
``SyndicationFeed.root_attributes(self, )``
Return a ``dict`` of attributes to add to the root feed element
2  docs/ref/models/fields.txt
@@ -555,7 +555,7 @@ By default, :class:`FileField` instances are
created as ``varchar(100)`` columns in your database. As with other fields, you
can change the maximum length using the :attr:`~CharField.max_length` argument.
-.. _`strftime formatting`:
+.. _`strftime formatting`:
2  docs/ref/models/querysets.txt
@@ -94,7 +94,7 @@ the query construction and is not part of the public API. However, it is safe
(and fully supported) to pickle and unpickle the attribute's contents as
described here.
-.. _pickle:
+.. _pickle:
.. _queryset-api:
9 docs/ref/settings.txt
@@ -341,7 +341,7 @@ Supported for the PostgreSQL_ (``postgresql``, ``postgresql_psycopg2``) and
MySQL_ (``mysql``) backends.
.. _PostgreSQL:
-.. _MySQL:
+.. _MySQL:
.. setting:: TEST_COLLATION
@@ -353,10 +353,9 @@ Default: ``None``
The collation order to use when creating the test database. This value is
passed directly to the backend, so its format is backend-specific.
-Only supported for the ``mysql`` backend (see `section 10.3.2`_ of the MySQL
-manual for details).
+Only supported for the ``mysql`` backend (see the `MySQL manual`_ for details).
-.. _section 10.3.2:
+.. _MySQL manual: MySQL_
.. setting:: TEST_NAME
@@ -734,7 +733,7 @@ system's standard umask.
get totally incorrect behavior.
-.. _documentation for os.chmod:
+.. _documentation for os.chmod:
.. setting:: FIRST_DAY_OF_WEEK
6 docs/ref/unicode.txt
@@ -21,8 +21,8 @@ data. Normally, this means giving it an encoding of UTF-8 or UTF-16. If you use
a more restrictive encoding -- for example, latin1 (iso8859-1) -- you won't be
able to store certain characters in the database, and information will be lost.
- * MySQL users, refer to the `MySQL manual`_ (section 10.3.2 for MySQL 5.1) for
- details on how to set or alter the database character set encoding.
+ * MySQL users, refer to the `MySQL manual`_ (section for MySQL 5.1)
+ for details on how to set or alter the database character set encoding.
* PostgreSQL users, refer to the `PostgreSQL manual`_ (section 21.2.2 in
PostgreSQL 8) for details on creating databases with the correct encoding.
@@ -30,7 +30,7 @@ able to store certain characters in the database, and information will be lost.
* SQLite users, there is nothing you need to do. SQLite always uses UTF-8
for internal encoding.
-.. _MySQL manual:
+.. _MySQL manual:
.. _PostgreSQL manual:
All of Django's database backends automatically convert Unicode strings into
4 docs/releases/0.96.txt
@@ -227,8 +227,8 @@ start of your tests. This makes testing with real data much easier.
See `the testing documentation`_ for the full details.
-.. _doctest:
-.. _unittest:
+.. _doctest:
+.. _unittest:
.. _the testing documentation:
.. _serialization formats:
2  docs/topics/db/queries.txt
@@ -327,7 +327,7 @@ translates (roughly) into the following SQL::
arguments whose names and values are evaluated at runtime. For more
information, see `Keyword Arguments`_ in the official Python tutorial.
- .. _`Keyword Arguments`:
+ .. _`Keyword Arguments`:
If you pass an invalid keyword argument, a lookup function will raise
3  docs/topics/db/sql.txt
@@ -251,5 +251,4 @@ necessary. (Also note that Django expects the ``"%s"`` placeholder, *not* the
``"?"`` placeholder, which is used by the SQLite Python bindings. This is for
the sake of consistency and sanity.)
-.. _Python DB-API:
+.. _Python DB-API:
2  docs/topics/files.txt
@@ -55,7 +55,7 @@ Internally, Django uses a ``django.core.files.File`` any time it needs to
represent a file. This object is a thin wrapper around Python's `built-in file
object`_ with some Django-specific additions.
-.. _built-in file object:
+.. _built-in file object:
Most of the time you'll simply use a ``File`` that Django's given you (i.e. a
file attached to a model as above, or perhaps an uploaded file).
20 docs/topics/http/file-uploads.txt
@@ -30,7 +30,7 @@ is a dictionary containing a key for each ``FileField`` (or ``ImageField``, or
other ``FileField`` subclass) in the form. So the data from the above form would
be accessible as ``request.FILES['file']``.
-Note that ``request.FILES`` will only contain data if the request method was
+Note that ``request.FILES`` will only contain data if the request method was
``POST`` and the ``<form>`` that posted the request has the attribute
``enctype="multipart/form-data"``. Otherwise, ``request.FILES`` will be empty.
@@ -140,19 +140,19 @@ Three settings control Django's file upload behavior:
Defaults to your system's standard temporary directory (i.e. ``/tmp`` on
most Unix-like systems).
The numeric mode (i.e. ``0644``) to set newly uploaded files to. For
more information about what these modes mean, see the `documentation for
If this isn't given or is ``None``, you'll get operating-system
dependent behavior. On most platforms, temporary files will have a mode
of ``0600``, and files saved from memory will be saved using the
system's standard umask.
.. warning::
If you're not familiar with file modes, please note that the leading
``0`` is very important: it indicates an octal number, which is the
way that modes must be specified. If you try to use ``644``, you'll
@@ -173,7 +173,7 @@ Three settings control Django's file upload behavior:
Which means "try to upload to memory first, then fall back to temporary
-.. _documentation for os.chmod:
+.. _documentation for os.chmod:
``UploadedFile`` objects
@@ -197,17 +197,17 @@ define the following methods/attributes:
Only files uploaded onto disk will have this method; it returns the full
path to the temporary uploaded file.
.. note::
Like regular Python files, you can read the file line-by-line simply by
iterating over the uploaded file:
.. code-block:: python
for line in uploadedfile:
However, *unlike* standard Python files, :class:`UploadedFile` only
understands ``\n`` (also known as "Unix-style") line endings. If you know
that you need to handle uploaded files with different line endings, you'll
4 docs/topics/install.txt
@@ -53,7 +53,7 @@ for each platform.
.. _Apache:
.. _mod_wsgi:
-.. _WSGI:
+.. _WSGI:
.. _server-arrangements wiki page:
.. _database-installation:
@@ -125,7 +125,7 @@ Django will need permission to create a test database.
.. _compiled Windows version:
.. _MySQLdb:
.. _SQLite:
-.. _pysqlite:
+.. _pysqlite:
.. _cx_Oracle:
.. _Oracle:
.. _Sybase SQL Anywhere:
14 docs/topics/testing.txt
@@ -147,7 +147,7 @@ as must have ``CREATE DATABASE`` rights.
For more details about how doctest works, see the `standard library
documentation for doctest`_.
-.. _doctest:
+.. _doctest:
.. _standard library documentation for doctest: doctest_
Writing unit tests
@@ -197,9 +197,9 @@ suite.
For more details about ``unittest``, see the `standard library unittest
-.. _unittest:
+.. _unittest:
.. _standard library unittest documentation: unittest_
-.. _suggested organization:
+.. _suggested organization:
Which should I use?
@@ -414,7 +414,7 @@ a different focus. In short:
A comprehensive test suite should use a combination of both test types.
.. _Twill:
-.. _Selenium:
+.. _Selenium:
Overview and a quick example
@@ -467,8 +467,8 @@ Note a few important things about how the test client works:
This black magic (essentially a patching of Django's template system in
memory) only happens during test running.
-.. _urllib:
-.. _urllib2:
+.. _urllib:
+.. _urllib2:
Making requests
@@ -809,7 +809,7 @@ can access these properties as part of a test condition.
A dictionary-like object containing session information. See the
:ref:`session documentation<topics-http-sessions>` for full details.
-.. _Cookie module documentation:
+.. _Cookie module documentation:
Please sign in to comment.
Something went wrong with that request. Please try again.