0
0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
django/docs
2014-03-08 11:25:23 +08:00
..
_ext
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq
howto Removed WSGI upgrade instructions for Django 1.3 and earlier. 2014-03-02 16:19:28 -05:00
internals Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
intro Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
man
misc
ref Fixed #22034 -- Added a specific set of relation checks for GenericInlineModelAdmin. 2014-03-08 11:25:23 +08:00
releases Fixed #22185 -- Added settings.CSRF_COOKIE_AGE 2014-03-06 08:28:43 -05:00
topics Fixed #14549 - Removed restriction of single FKs on intermediary tables 2014-03-05 22:33:58 +02:00
conf.py Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
contents.txt
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Added first cut at reference documentation for the checks framework. 2014-03-03 18:56:11 +08:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
spelling_wordlist Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -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 ``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/