django

mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00

History

Tim Graham 61225ef721 Removed the importance of "core developers" in triaging tickets, etc.		2016-12-21 20:18:13 -05:00
..
_ext	Fixed missing versionadded/changed annotations on docs.djangoproject.com.	2016-12-14 14:31:29 -05:00
_theme
faq	Removed the importance of "core developers" in triaging tickets, etc.	2016-12-21 20:18:13 -05:00
howto	Normalized casing of "custom user model".	2016-11-23 15:14:28 -05:00
internals	Removed the importance of "core developers" in triaging tickets, etc.	2016-12-21 20:18:13 -05:00
intro	Updated doc links to virtualenv website.	2016-11-22 08:36:41 -05:00
man
misc
ref	Fixed #27600 -- Suppressed the REPL during shell's reading from stdin.	2016-12-21 17:05:33 -05:00
releases	Fixed #27497 -- Improved support of geodetic coordinates on SpatiaLite.	2016-12-15 15:31:07 -05:00
topics	Documented how to copy a OneToOneField.	2016-12-17 08:39:52 -05:00
conf.py	Removed deprecated html_translator_class sphinx config option.	2016-12-05 14:47:44 -05: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	Fixed #27439 -- Documented macOS locale configuration for Django tests.	2016-12-20 12:58:14 -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/