Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Cleaned up a bunch of minor doc stuff:

  * Removed flatpages/redirects README; no other contrib apps have those.
  * Cleaned up top-level README to be more readable.
  * Removed outdated references to old docs (Fixes #8701)

git-svn-id: http://code.djangoproject.com/svn/django/trunk@8857 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 23f012dbfad47849ef6c8d9bf3181eb29cacb3e9 1 parent 1156db7
@jacobian jacobian authored
View
22 README
@@ -2,19 +2,21 @@ Django is a high-level Python Web framework that encourages rapid development
and clean, pragmatic design.
All documentation is in the "docs" directory and online at
-http://www.djangoproject.com/documentation/. If you're just getting started,
-here's how we recommend you read the docs:
+http://docs.djangoproject.com/en/dev/. If you're just getting started, here's
+how we recommend you read the docs:
- * First, read docs/install.txt for instructions on installing Django.
+ * First, read docs/intro/install.txt for instructions on installing Django.
- * Next, work through the tutorials in order (docs/tutorial01.txt,
- docs/tutorial02.txt, etc.).
+ * Next, work through the tutorials in order (docs/intro/tutorial01.txt,
+ docs/intro/tutorial02.txt, etc.).
- * If you want to set up an actual deployment server, read docs/modpython.txt
- for instructions on running Django under mod_python.
+ * If you want to set up an actual deployment server, read
+ docs/howto/deployment/modpython.txt for instructions on running Django
+ under mod_python.
- * The rest of the documentation is of the reference-manual variety.
- Read it -- and the FAQ -- as you run into problems.
+ * You'll probably want to read through the topical guides (in docs/topics)
+ next; from there you can jump to the HOWTOs (in docs/howto) for specific
+ problems, and check out the reference (docs/ref) for gory details.
Docs are updated rigorously. If you find any problems in the docs, or think they
should be clarified in any way, please take 30 seconds to fill out a ticket
@@ -25,7 +27,7 @@ http://code.djangoproject.com/newticket
To get more help:
* Join the #django channel on irc.freenode.net. Lots of helpful people
- hang out there. Read the archives at http://simon.bofh.ms/logger/django/ .
+ hang out there. Read the archives at http://oebfare.com/logger/django/.
* Join the django-users mailing list, or read the archives, at
http://groups.google.com/group/django-users.
View
10 django/conf/global_settings.py
@@ -257,25 +257,25 @@
FILE_UPLOAD_PERMISSIONS = None
# Default formatting for date objects. See all available format strings here:
-# http://www.djangoproject.com/documentation/templates/#now
+# http://docs.djangoproject.com/en/dev/ref/templates/builtins/#now
DATE_FORMAT = 'N j, Y'
# Default formatting for datetime objects. See all available format strings here:
-# http://www.djangoproject.com/documentation/templates/#now
+# http://docs.djangoproject.com/en/dev/ref/templates/builtins/#now
DATETIME_FORMAT = 'N j, Y, P'
# Default formatting for time objects. See all available format strings here:
-# http://www.djangoproject.com/documentation/templates/#now
+# http://docs.djangoproject.com/en/dev/ref/templates/builtins/#now
TIME_FORMAT = 'P'
# Default formatting for date objects when only the year and month are relevant.
# See all available format strings here:
-# http://www.djangoproject.com/documentation/templates/#now
+# http://docs.djangoproject.com/en/dev/ref/templates/builtins/#now
YEAR_MONTH_FORMAT = 'F Y'
# Default formatting for date objects when only the month and day are relevant.
# See all available format strings here:
-# http://www.djangoproject.com/documentation/templates/#now
+# http://docs.djangoproject.com/en/dev/ref/templates/builtins/#now
MONTH_DAY_FORMAT = 'F j'
# Do you want to manage transactions manually?
View
8 django/contrib/flatpages/README.TXT
@@ -1,8 +0,0 @@
-This is an optional add-on app, flatpages.
-
-For full documentation, see either of these:
-
- * The file docs/flatpages.txt in the Django distribution
- * http://www.djangoproject.com/documentation/flatpages/ on the Web
-
-Both have identical content.
View
8 django/contrib/redirects/README.TXT
@@ -1,8 +0,0 @@
-This is an optional add-on app, redirects.
-
-For full documentation, see either of these:
-
- * The file django/docs/redirects.txt in the Django distribution
- * http://www.djangoproject.com/documentation/redirects/ on the Web
-
-Both have identical content.
View
4 docs/intro/whatsnext.txt
@@ -110,7 +110,7 @@ On the Web
----------
The most recent version of the Django documentation lives at
-http://www.djangoproject.com/documentation/ . These HTML pages are generated
+http://docs.djangoproject.com/en/dev/. These HTML pages are generated
automatically from the text files in source control. That means they reflect the
"latest and greatest" in Django -- they include the very latest corrections and
additions, and they discuss the latest Django features, which may only be
@@ -231,4 +231,4 @@ We follow this policy:
* The `main documentation Web page`_ includes links to documentation for
all previous versions.
-.. _main documentation Web page: http://www.djangoproject.com/documentation/
+.. _main documentation Web page: http://docs.djangoproject.com/en/dev/
View
2  docs/man/daily_cleanup.1
@@ -22,7 +22,7 @@ It should be in Python-import form, e.g. "myproject.settings".
.SH "SEE ALSO"
The sessions documentation:
.sp
-.I http://www.djangoproject.com/documentation/sessions/
+.I http://docs.djangoproject.com/en/dev/topics/http/sessions/
.SH "AUTHORS/CREDITS"
Originally developed at World Online in Lawrence, Kansas, USA. Refer to the
View
2  docs/man/django-admin.1
@@ -168,7 +168,7 @@ It should be in Python-import form, e.g. "myproject.settings".
Full descriptions of all these options, with examples, as well as documentation
for the rest of the Django framework, can be found on the Django site:
.sp
-.I http://www.djangoproject.com/documentation/
+.I http://docs.djangoproject.com/en/dev/
.sp
or in the distributed documentation.
.SH "AUTHORS/CREDITS"
View
16 docs/releases/1.0-alpha-1.txt
@@ -33,8 +33,8 @@ Refactored admin application (newforms-admin)
and redesigned with extensibility and customization in mind. Full
documentation for the admin application is available online in the
official Django documentation:
-
- http://www.djangoproject.com/documentation/admin/
+
+ :ref:`admin reference <ref-contrib-admin>`
Improved Unicode handling
Django's internals have been refactored to use Unicode throughout;
@@ -44,8 +44,8 @@ Improved Unicode handling
third-party libraries and systems which may or may not handle
Unicode gracefully. Details are available in Django's
Unicode-handling documentation:
-
- http://www.djangoproject.com/documentation/unicode/
+
+ :ref:`unicode reference <ref-unicode>`
An improved Django ORM
Django's object-relational mapper -- the component which provides
@@ -68,9 +68,7 @@ Automatic escaping of template variables
and allows both variables and larger template constructs to be
marked as safe (requiring no escaping) or unsafe (requiring
escaping). A full guide to this feature is in the documentation
- for the Django template system:
-
- http://www.djangoproject.com/documentation/templates/#automatic-html-escaping
+ for the :ttag:`autoescape` tag.
There are many more new features, many bugfixes and many enhancements
to existing features from previous releases. The ``newforms`` library,
@@ -87,7 +85,7 @@ complete guide to these changes will be available as part of the final
Django 1.0 release, and a comprehensive list of backwards-incompatible
changes is also available on the Django wiki for those who want to
begin developing and testing their upgrade process:
-
+
http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges
@@ -158,7 +156,7 @@ to join the discussions there.
Django's online documentation also includes pointers on how to
contribute to Django:
- http://www.djangoproject.com/documentation/contributing/
+ :ref:`contributing to Django <internals-contributing>`
Contributions on any level -- developing code, writing
documentation or simply triaging tickets and helping to test proposed
View
2  docs/releases/1.0-alpha-2.txt
@@ -131,7 +131,7 @@ to join the discussions there.
Django's online documentation also includes pointers on how to
contribute to Django:
- http://www.djangoproject.com/documentation/contributing/
+ :ref:`contributing to Django <internals-contributing>`
Contributions on any level -- developing code, writing
documentation or simply triaging tickets and helping to test proposed
View
2  docs/releases/1.0-beta-2.txt
@@ -114,7 +114,7 @@ to join the discussions there.
Django's online documentation also includes pointers on how to
contribute to Django:
- http://www.djangoproject.com/documentation/contributing/
+ :ref:`contributing to Django <internals-contributing>`
Contributions on any level -- developing code, writing
documentation or simply triaging tickets and helping to test proposed
View
2  docs/releases/1.0-beta.txt
@@ -148,7 +148,7 @@ to join the discussions there.
Django's online documentation also includes pointers on how to
contribute to Django:
- http://www.djangoproject.com/documentation/contributing/
+ :ref:`contributing to Django <internals-contributing>`
Contributions on any level -- developing code, writing
documentation or simply triaging tickets and helping to test proposed

0 comments on commit 23f012d

Please sign in to comment.
Something went wrong with that request. Please try again.