1
0
mirror of https://github.com/django/django.git synced 2024-12-29 12:36:08 +00:00
django/docs
2016-02-18 18:58:18 -05:00
..
_ext
_theme
faq Changed gypsy to manouche in docs and tests. 2016-02-03 09:45:30 -05:00
howto Followed recommended ValidationError use in docs. 2016-02-17 09:05:33 -05:00
internals Fixed #26154 -- Deprecated CommaSeparatedIntegerField 2016-02-10 17:57:43 -05:00
intro Fixed #26221 -- Used find_packages() in reusable apps tutorial. 2016-02-15 19:25:26 -05:00
man
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref Fixed #26107 -- Added option to int_list_validator() to allow negative integers. 2016-02-18 18:58:18 -05:00
releases Fixed #26107 -- Added option to int_list_validator() to allow negative integers. 2016-02-18 18:58:18 -05:00
topics Refs #19353 -- Added tests for using custom user models with built-in auth forms. 2016-02-17 10:26:07 -05:00
conf.py Fixed possible "RuntimeError: maximum recursion depth exceeded" building docs. 2016-02-16 07:30:32 -05:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
make.bat
Makefile
README
spelling_wordlist Changed gypsy to manouche in docs and tests. 2016-02-03 09:45:30 -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/