mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
Code Issues 25 Releases Wiki Activity
3a85aae2ea
django/docs
History
Tim Graham 3a85aae2ea Revert "Improve cookie based session backend docs." refs #20418 
This reverts commit d9c01da1f8.

This is poor advice as it breaks the test client login (refs #22934).
We can add a note like this back after refs #22986 is resolved.
2014-07-09 13:54:41 -04:00
..
_ext Removed duplicate "Deprecated in Django A.B" text in docs. 2014-06-06 20:31:23 -04:00
_theme Made docs CSS for versionchanged/added more similar to docs.djangoproject.com. 2014-06-30 18:38:30 -04:00
faq Fixed #22880 -- Added FAQ entry about UnicodeDecodeError 2014-06-24 09:02:28 +02:00
howto Fixed #22812 -- Refactored lookup API documentation. 2014-07-08 20:05:49 -04:00
internals Removed myself from committers. 2014-07-02 23:33:03 -05:00
intro Included irc link in paragraph to allow for l10n 2014-07-01 21:54:32 +02:00
man Completed long overdue sqlinitialdata deprecation. 2014-05-11 23:15:59 -03:00
misc
ref Fixed #22351 -- Removed usage of lambdas in model field options. 2014-07-09 07:31:50 -04:00
releases Fixed #22812 -- Refactored lookup API documentation. 2014-07-08 20:05:49 -04:00
topics Revert "Improve cookie based session backend docs." refs #20418 2014-07-09 13:54:41 -04:00
conf.py Fixed #17238 -- Added source code links to docs using sphinx.ext.viewcode. 2014-06-07 08:54:54 -04:00
contents.txt
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Fixed #22812 -- Refactored lookup API documentation. 2014-07-08 20:05:49 -04:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
spelling_wordlist Fixed #22796 -- Added a more basic explanations of forms. 2014-06-24 14:55:22 -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/