django

mirror of https://github.com/django/django.git synced 2024-11-30 07:06:18 +01:00

History

Jonatas CD 9da45ff352 Fixed #26985 -- Doc'd that ForeignKey.to_field reference must be unique.		2016-11-15 11:09:23 -05:00
..
_ext	Fixed #27463 -- Fixed E741 flake8 warnings.	2016-11-14 17:40:28 -05:00
_theme
faq	Fixed #27425 -- Removed obsolete "developers for hire" FAQ.	2016-11-03 12:42:36 +01:00
howto	Fixed #27133 -- Doc'd how to provide initial data with migrations.	2016-11-06 12:51:36 +01:00
internals	Refs #27392 -- Removed "Tests that", "Ensures that", etc. from test docstrings.	2016-11-10 21:30:21 -05:00
intro	Updated "fork Django on GitHub" link.	2016-11-04 05:47:49 +01:00
man
misc
ref	Fixed #26985 -- Doc'd that ForeignKey.to_field reference must be unique.	2016-11-15 11:09:23 -05:00
releases	Dropped support for GDAL 1.7 and 1.8	2016-11-12 17:28:03 +01:00
topics	Refs #25284 -- Corrected an obsolete implicit __in lookup example.	2016-11-15 08:25:02 -05:00
conf.py	Added a CVE role for Sphinx.	2016-09-26 15:48:40 -04:00
contents.txt
glossary.txt
index.txt	Fixed #26709 -- Added class-based indexes.	2016-06-27 10:41:01 -04:00
make.bat
Makefile
README
spelling_wordlist	Readded 'pytz' to spelling wordlist.	2016-11-05 13:28:42 +01: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/