Skip to content

Commit

Permalink
Update internal link for sphinx 1.3.x. refs: #1 #2
Browse files Browse the repository at this point in the history
  • Loading branch information
Surgo committed Oct 13, 2012
1 parent db8fdc5 commit 4d7f9c9
Show file tree
Hide file tree
Showing 40 changed files with 297 additions and 627 deletions.
28 changes: 7 additions & 21 deletions docs/add_ons.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,14 @@ admin
=====

The automatic Django administrative interface. For more information, see
`Tutorial 2`_.

.. _Tutorial 2: http://www.djangoproject.com/documentation/tutorial2/
:doc:`Tutorial 2 <tutorial02>`.

auth
====

Django's authentication framework.

See the `authentication documentation`_.

.. _authentication documentation: http://www.djangoproject.com/documentation/authentication/
See the :doc:`authentication documentation <authentication>`.

comments
========
Expand All @@ -41,9 +37,7 @@ csrf

A middleware for preventing Cross Site Request Forgeries

See the `csrf documentation`_.

.. _csrf documentation: http://www.djangoproject.com/documentation/csrf/
See the :doc:`csrf documentation <csrf>`.

humanize
========
Expand Down Expand Up @@ -115,9 +109,7 @@ flatpages

A framework for managing simple "flat" HTML content in a database.

See the `flatpages documentation`_.

.. _flatpages documentation: http://www.djangoproject.com/documentation/flatpages/
See the :doc:`flatpages documentation <flatpages>`.

markup
======
Expand All @@ -135,9 +127,7 @@ redirects

A framework for managing redirects.

See the `redirects documentation`_.

.. _redirects documentation: http://www.djangoproject.com/documentation/redirects/
See the :doc:`redirects documentation <redirects>`.

sites
=====
Expand All @@ -146,18 +136,14 @@ A light framework that lets you operate multiple Web sites off of the same
database and Django installation. It gives you hooks for associating objects to
one or more sites.

See the `sites documentation`_.

.. _sites documentation: http://www.djangoproject.com/documentation/sites/
See the :doc:`sites documentation <sites>`.

syndication
===========

A framework for generating syndication feeds, in RSS and Atom, quite easily.

See the `syndication documentation`_.

.. _syndication documentation: http://www.djangoproject.com/documentation/syndication/
See the :doc:`syndication documentation <syndication>`.

Other add-ons
=============
Expand Down
6 changes: 2 additions & 4 deletions docs/apache_auth.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Authenticating against Django's user database from Apache

Since keeping multiple authentication databases in sync is a common problem when
dealing with Apache, you can configuring Apache to authenticate against Django's
`authentication system`_ directly. For example, you could:
:doc:`authentication system <authentication>` directly. For example, you could:

* Serve media files directly from Apache only to authenticated users.

Expand Down Expand Up @@ -49,7 +49,7 @@ location to users marked as staff members. You can use a set of
Defaults to ``off``.

``DjangoPermissionName`` The name of a permission to require for
access. See `custom permissions`_ for
access. See :doc:`custom permissions <authentication>` for
more information.

By default no specific permission will be
Expand All @@ -65,7 +65,5 @@ are equivalent::
SetEnv DJANGO_SETTINGS_MODULE mysite.settings
PythonOption DJANGO_SETTINGS_MODULE mysite.settings

.. _authentication system: http://www.djangoproject.com/documentation/authentication/
.. _Subversion: http://subversion.tigris.org/
.. _mod_dav: http://httpd.apache.org/docs/2.0/mod/mod_dav.html
.. _custom permissions: http://www.djangoproject.com/documentation/authentication/#custom-permissions
117 changes: 46 additions & 71 deletions docs/api_stability.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ In this context, stable means:
- All the public APIs -- everything documented in the linked documents, and
all methods that don't begin with an underscore -- will not be moved or
renamed without providing backwards-compatible aliases.

- If new features are added to these APIs -- which is quite possible --
they will not break or change the meaning of existing methods. In other
words, "stable" does not (necessarily) mean "complete."

- If, for some reason, an API declared stable must be removed or replaced, it
will be declared deprecated but will remain in the API until at least
version 1.1. Warnings will be issued when the deprecated method is
called.

- We'll only break backwards compatibility of these APIs if a bug or
security hole makes it completely unavoidable.

Expand All @@ -32,48 +32,48 @@ Stable APIs

These APIs are stable:

- `Caching`_.
- `Custom template tags and libraries`_ (with the possible exception for a
- :doc:`Caching <cache>`.

- :doc:`Custom template tags and libraries <templates_python>` (with the possible exception for a
small change in the way templates are registered and loaded).
- `Database lookup`_ (with the exception of validation; see below).
- `django-admin utility`_.
- `FastCGI integration`_.
- `Flatpages`_.
- `Generic views`_.
- `Internationalization`_.
- `Legacy database integration`_.
- `Model definition`_ (with the exception of generic relations; see below).
- `mod_python integration`_.
- `Redirects`_.
- `Request/response objects`_.
- `Sending email`_.
- `Sessions`_.
- `Settings`_.
- `Syndication`_.
- `Template language`_ (with the exception of some possible disambiguation

- :doc:`Database lookup <db-api>` (with the exception of validation; see below).

- :doc:`django-admin utility <django-admin>`.

- :doc:`FastCGI integration <fastcgi>`.

- :doc:`Flatpages <flatpages>`.

- :doc:`Generic views <generic_views>`.

- :doc:`Internationalization <i18n>`.

- :doc:`Legacy database integration <legacy_databases>`.

- :doc:`Model definition <model-api>` (with the exception of generic relations; see below).

- :doc:`mod_python integration <modpython>`.

- :doc:`Redirects <redirects>`.

- :doc:`Request/response objects <request_response>`.

- :doc:`Sending email <email>`.

- :doc:`Sessions <sessions>`.

- :doc:`Settings <settings>`.

- :doc:`Syndication <syndication_feeds>`.

- :doc:`Template language <templates>` (with the exception of some possible disambiguation
of how tag arguments are passed to tags and filters).
- `Transactions`_.
- `URL dispatch`_.

- :doc:`Transactions <transactions>`.

- :doc:`URL dispatch <url_dispatch>`.

You'll notice that this list comprises the bulk of Django's APIs. That's right
-- most of the changes planned between now and Django 1.0 are either under the
hood, feature additions, or changes to a few select bits. A good estimate is
Expand All @@ -82,12 +82,12 @@ that 90% of Django can be considered forwards-compatible at this point.
That said, these APIs should *not* be considered stable, and are likely to
change:

- `Forms and validation`_ will most likely be compeltely rewritten to
- :doc:`Forms and validation <forms>` will most likely be compeltely rewritten to
deemphasize Manipulators in favor of validation-aware models.

- `Serialization`_ is under heavy development; changes are likely.
- :doc:`Serialization <serialization>` is under heavy development; changes are likely.

- The `authentication`_ framework is changing to be far more flexible, and
- The :doc:`authentication <authentication>` framework is changing to be far more flexible, and
API changes may be necessary.

- Generic relations will most likely be moved out of core and into the
Expand All @@ -96,28 +96,3 @@ change:

- The comments framework, which is yet undocumented, will likely get a complete
rewrite before Django 1.0. Even if the change isn't quite that drastic,
there will at least be moderate changes.

.. _caching: http://www.djangoproject.com/documentation/cache/
.. _custom template tags and libraries: http://www.djangoproject.com/documentation/templates_python/
.. _database lookup: http://www.djangoproject.com/documentation/db_api/
.. _django-admin utility: http://www.djangoproject.com/documentation/django_admin/
.. _fastcgi integration: http://www.djangoproject.com/documentation/fastcgi/
.. _flatpages: http://www.djangoproject.com/documentation/flatpages/
.. _generic views: http://www.djangoproject.com/documentation/generic_views/
.. _internationalization: http://www.djangoproject.com/documentation/i18n/
.. _legacy database integration: http://www.djangoproject.com/documentation/legacy_databases/
.. _model definition: http://www.djangoproject.com/documentation/model_api/
.. _mod_python integration: http://www.djangoproject.com/documentation/modpython/
.. _redirects: http://www.djangoproject.com/documentation/redirects/
.. _request/response objects: http://www.djangoproject.com/documentation/request_response/
.. _sending email: http://www.djangoproject.com/documentation/email/
.. _sessions: http://www.djangoproject.com/documentation/sessions/
.. _settings: http://www.djangoproject.com/documentation/settings/
.. _syndication: http://www.djangoproject.com/documentation/syndication/
.. _template language: http://www.djangoproject.com/documentation/templates/
.. _transactions: http://www.djangoproject.com/documentation/transactions/
.. _url dispatch: http://www.djangoproject.com/documentation/url_dispatch/
.. _forms and validation: http://www.djangoproject.com/documentation/forms/
.. _serialization: http://www.djangoproject.com/documentation/serialization/
.. _authentication: http://www.djangoproject.com/documentation/authentication/
Loading

0 comments on commit 4d7f9c9

Please sign in to comment.