django/docs
ruchit2801 04042b2b44 Fixed #30463 -- Fixed crash of deprecation message when Meta.ordering contains expressions.
Regression in 1b1f64ee5a.
2019-05-18 19:29:00 +02:00
..
_ext
_theme
faq
howto
internals Fixed #30220 -- Added support for headless mode in selenium tests. 2019-05-17 08:14:54 +02:00
intro
man
misc
ref Changed docs to link to Python's description of iterable. 2019-05-17 17:27:19 +02:00
releases Fixed #30463 -- Fixed crash of deprecation message when Meta.ordering contains expressions. 2019-05-18 19:29:00 +02:00
topics
Makefile
README
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
make.bat
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/