0
0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
django/docs
2014-04-21 13:19:46 -04:00
..
_ext
_theme
faq Added Python 3.4 support notes. 2014-03-27 08:01:33 -04:00
howto Changed paths in docs that referred to Python 2. 2014-04-20 08:34:01 +02:00
internals Fixed #22444 -- Marked initial SQL/fixture loading as deprecated. 2014-04-17 20:36:52 -04:00
intro Fixed #22472 -- Clarified meaning of dots in tutorial 4 code block. 2014-04-18 12:10:46 -04:00
man
misc
ref Corrected the section identifier for MySQL unicode reference. 2014-04-21 13:19:46 -04:00
releases Fixed #22417 -- Added additional documentation for refs #16969. 2014-04-19 21:39:08 -04:00
topics Fixed #22417 -- Added additional documentation for refs #16969. 2014-04-19 21:39:08 -04:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist Fixed spelling errors in documentation. 2014-04-16 09:39:00 -04: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 ``sudo 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/