django

History

Amine 8b5a4fa941 Fixed a broken link in docs/internals/contributing/writing-documentation.txt.		2016-03-19 16:19:01 -04:00
..
_ext	…
_theme	…
faq	Changed gypsy to manouche in docs and tests.	2016-02-03 09:45:30 -05:00
howto	Fixed #26302 -- Removed incorrect statement about virtual hosts.	2016-03-09 09:00:58 -05:00
internals	Fixed a broken link in docs/internals/contributing/writing-documentation.txt.	2016-03-19 16:19:01 -04:00
intro	Fixed #26255 -- Fixed orphaned include() reference following tutorial reordering.	2016-03-09 12:18:21 -05:00
man	…
misc	…
ref	Refs #24227 -- Replaced M2M isinstance checks by field.many_to_many	2016-03-19 09:24:27 +01:00
releases	Fixed #25658 -- Allowed inspectdb to inspect a specific set of tables.	2016-03-18 08:41:15 -04:00
topics	Fixed DiscoverRunner failfast parameter default in docs.	2016-03-15 18:33:35 -04:00
Makefile	…
README	…
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	…
spelling_wordlist	Added 'prefetches to docs/spelling_wordlist.	2016-02-26 16:06:34 -05: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 ``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/