mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-23 07:40:44 +00:00
Code Issues32 Releases Wiki Activity
23ff98888e
django/docs
History
Tim Graham a3d710a38f [1.7.x] Revert "Improve cookie based session backend docs." refs 
This reverts commit d9c01da1f8ba3d4e0947fd1d619c8f4a9b013360.

This is poor advice as it breaks the test client login (refs ).
We can add a note like this back after refs  is resolved.

Backport of 3a85aae2ea from master
2014-07-09 14:12:32 -04:00
..
_ext
[1.7.x] Removed duplicate "Deprecated in Django A.B" text in docs.
2014-06-07 07:25:02 -04:00
_theme
[1.7.x] Removed duplicate "Deprecated in Django A.B" text in docs.
2014-06-07 07:25:02 -04:00
faq
[1.7.x] Fixed -- Added FAQ entry about UnicodeDecodeError
2014-06-24 09:03:06 +02:00
howto
[1.7.x] Fixed -- Refactored lookup API documentation.
2014-07-08 20:13:24 -04:00
internals
[1.7.x] Fixed -- Added instructions for translating documentation.
2014-07-02 13:22:14 -04:00
intro
[1.7.x] Included irc link in paragraph to allow for l10n
2014-07-01 21:56:28 +02:00
man
Removed a man page for a command that was removed
2014-01-10 15:23:06 -08:00
misc
Fixed -- Documented some of the design decisions of the cache framework.
2014-01-16 21:13:08 -05:00
ref
[1.7.x] Fixed -- Removed usage of lambdas in model field options.
2014-07-09 07:32:44 -04:00
releases
[1.7.x] Fixed -- Refactored lookup API documentation.
2014-07-08 20:13:24 -04:00
topics
[1.7.x] Revert "Improve cookie based session backend docs." refs
2014-07-09 14:12:32 -04:00
conf.py
[1.7.x] Fixed several typos in Django
2014-05-29 07:53:02 -04:00
contents.txt
Removed an obsolete documentation page about admin style customization.
2012-09-10 17:19:35 -07:00
glossary.txt
Fixed some typos in the documentation.
2014-03-02 17:05:57 +01:00
index.txt
[1.7.x] Fixed -- Refactored lookup API documentation.
2014-07-08 20:13:24 -04:00
make.bat
Fixed - Fixed remaining broken links.
2013-01-02 18:32:57 -05:00
Makefile
Fixed -- Added a spelling checker for documentation.
2014-03-07 09:29:23 -05:00
README
Whitespace cleanup.
2013-10-10 16:49:20 -04:00
spelling_wordlist
[1.7.x] Fixed -- Added a more basic explanations of forms.
2014-06-24 14:58:53 -04:00

README 

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2].
This allows it to be built into other forms for easier viewing and browsing.

To create an HTML version of the docs:

* Install Sphinx (using ``sudo pip install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) at a shell prompt.

The documentation in _build/html/index.html can then be viewed in a web browser.

[1] http://docutils.sourceforge.net/rst.html
[2] http://sphinx-doc.org/