django

mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00

History

Jon Dufresne b915b9f10f Refs #27753 -- Deprecated django.utils.text.unescape_entities(). The function was undocumented and only required for compatibility with Python 2. Code should use Python's html.unescape() that was added in Python 3.4.		2019-05-08 08:00:59 +02:00
..
_ext	Fixed crash building translated docs since Sphinx 1.8.	2018-10-01 20:44:02 -04:00
_theme	Refs #20910 -- Replaced snippet directive with code-block.	2018-09-10 13:00:34 -04:00
faq	Used extlinks for Django's source code.	2019-03-28 20:32:17 -04:00
howto	Fixed #30365 -- Fixed syntax highlighting in SQL examples.	2019-04-23 12:37:50 +02:00
internals	Refs #27753 -- Deprecated django.utils.text.unescape_entities().	2019-05-08 08:00:59 +02:00
intro	Fixed #30399 -- Changed django.utils.html.escape()/urlize() to use html.escape()/unescape().	2019-04-25 15:09:07 +02:00
man	Updated man page for 2.2 final.	2019-04-01 12:04:08 +02:00
misc
ref	Fixed #30447 -- Added 'is_in_european_union' in GeoIP2.city() dict.	2019-05-07 13:31:44 +02:00
releases	Refs #27753 -- Deprecated django.utils.text.unescape_entities().	2019-05-08 08:00:59 +02:00
topics	Fixed #30245 -- Added -k option to DiscoverRunner.	2019-04-30 16:20:51 +02:00
conf.py	Moved extlinks in docs config to allow using 'version' variable.	2019-03-28 20:47:51 -04:00
contents.txt
glossary.txt
index.txt	Removed dead links to botbot.me.	2018-11-10 17:25:10 -05:00
make.bat
Makefile
README	Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints.	2019-04-18 14:41:15 +02:00
spelling_wordlist	Removed unused words from docs/spelling_wordlist.	2019-02-02 15:36:20 +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 ``python -m 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/