0
0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
django/docs
2016-03-09 14:55:55 +11:00
..
_ext
_theme
faq Changed gypsy to manouche in docs and tests. 2016-02-03 09:45:30 -05:00
howto Fixed #26303 -- Updated links to mod_wsgi docs. 2016-03-01 19:22:32 -05:00
internals Fixed #26033 -- Added Argon2 password hasher. 2016-03-08 11:22:18 -05:00
intro Refs #26312 -- Reworded tutorial 2 to avoid spelling "error". 2016-03-05 10:58:45 -05:00
man
misc
ref Fixed indenting in "Serving files in development" code example 2016-03-09 14:55:55 +11:00
releases Fixed #26332 -- Fixed a race condition in BaseCache.get_or_set(). 2016-03-08 11:44:37 -05:00
topics Fixed #26256 -- Added note about primary key serialization 2016-03-08 21:30:23 +01:00
conf.py Fixed possible "RuntimeError: maximum recursion depth exceeded" building docs. 2016-02-16 07:30:32 -05:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist Added 'prefetches to docs/spelling_wordlist. 2016-02-26 16:06:34 -05:00

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/