0
0
mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00
django/docs
2019-05-17 12:23:10 +02:00
..
_ext
_theme
faq
howto Fixed #30365 -- Fixed syntax highlighting in SQL examples. 2019-04-23 12:37:50 +02:00
internals Fixed #30220 -- Added support for headless mode in selenium tests. 2019-05-17 08:14:54 +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 #30199 -- Adjusted QuerySet.get_or_create() docs to highlight atomicity warning. 2019-05-17 12:23:10 +02:00
releases Fixed #30220 -- Added support for headless mode in selenium tests. 2019-05-17 08:14:54 +02:00
topics Added filename caption to LOGGING documentation examples. 2019-05-16 16:51:36 +02:00
conf.py
contents.txt
glossary.txt
index.txt
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

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/