django

mirror of https://github.com/django/django.git synced 2024-12-01 07:31:48 +01:00

History

Jon Dufresne 8c3e0eb1c1 Normalized spelling of "lowercase" and "lowercased".		2018-09-25 10:30:18 -04:00
..
_ext	Updated contributing tutorial's virtual environment instructions.	2018-09-19 14:37:44 -04:00
_theme	Refs #20910 -- Replaced snippet directive with code-block.	2018-09-10 13:00:34 -04:00
faq	Fixed #29261 -- Doc'd the reason for LICENSE.python.	2018-06-29 20:00:58 -04:00
howto	Emphasized that TemplatesSetting must be used to override widget templates.	2018-09-11 15:14:53 -04:00
internals	Normalized spelling of "lowercase" and "lowercased".	2018-09-25 10:30:18 -04:00
intro	Updated contributing tutorial's virtual environment instructions.	2018-09-19 14:37:44 -04:00
man
misc
ref	Normalized spelling of "lowercase" and "lowercased".	2018-09-25 10:30:18 -04:00
releases	Fixed #23646 -- Added QuerySet.bulk_update() to efficiently update many models.	2018-09-18 16:14:44 -04:00
topics	Normalized spelling of "lowercase" and "lowercased".	2018-09-25 10:30:18 -04:00
conf.py	Removed obsolete html_use_smartypants Sphinx option.	2018-09-18 11:51:04 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist	Fixed #28990 -- Added autosummarize parameter to BrinIndex.	2018-08-02 11:26:58 -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 ``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/