django

mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00

History

Dmitry Dygalo 5155c2b458 Fixed typo in 1.9.3/1.8.10 release date.		2016-03-02 07:08:36 -05:00
..
_ext	Fixed #23868 -- Added support for non-unique django-admin-options in docs.	2016-01-14 18:21:33 -05:00
_theme	Fixed many spelling mistakes in code, comments, and docs.	2015-12-03 12:48:24 -05:00
faq	Changed gypsy to manouche in docs and tests.	2016-02-03 09:45:30 -05:00
howto	Fixed #26303 -- Updated links to mod_wsgi docs.	2016-03-01 19:22:32 -05:00
internals	Fixed #25814 -- Added changing #django topic to release checklist.	2016-03-01 13:02:03 -05:00
intro	Fixed #26221 -- Used find_packages() in reusable apps tutorial.	2016-02-15 19:25:26 -05:00
man	Discouraged use of /tmp with predictable names.	2015-12-24 09:54:33 -05:00
misc	Fixed #26020 -- Normalized header stylings in docs.	2016-01-22 12:12:17 -05:00
ref	Fixed #26217 -- Added a warning about format strings to WeekArchiveView docs.	2016-03-01 10:29:52 -05:00
releases	Fixed typo in 1.9.3/1.8.10 release date.	2016-03-02 07:08:36 -05:00
topics	Fixed CVE-2016-2513 -- Fixed user enumeration timing attack during login.	2016-03-01 11:25:28 -05:00
conf.py	Fixed possible "RuntimeError: maximum recursion depth exceeded" building docs.	2016-02-16 07:30:32 -05:00
contents.txt	Fixed #26020 -- Normalized header stylings in docs.	2016-01-22 12:12:17 -05:00
glossary.txt	Fixed #26020 -- Normalized header stylings in docs.	2016-01-22 12:12:17 -05:00
index.txt	Fixed #26020 -- Normalized header stylings in docs.	2016-01-22 12:12:17 -05:00
make.bat
Makefile
README
spelling_wordlist	Added 'prefetches to docs/spelling_wordlist.	2016-02-26 16:06:34 -05: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 ``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/