django

mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00

History

Tim Graham 15cafaa565 Fixed #5726 -- Documented that inspectdb doesn't detect defaults.		2014-08-19 06:14:14 -04:00
..
_ext
_theme	Added newlines to the ends of CSS, HTML, and JavaScript files missing them.	2014-08-12 19:22:09 -04:00
faq	Fixed #23016 -- Updated FAQs per Aymeric's suggestions.	2014-08-12 13:46:10 -04:00
howto	Fixed #14638 -- Clarified model Field.to_python() docs.	2014-08-18 12:53:25 -04:00
internals	Fixed #23269 -- Deprecated django.utils.remove_tags() and removetags filter.	2014-08-15 08:20:02 -04:00
intro	Fixed #23303 -- Added BEGIN and COMMIT statements to the output of sqlmigrate.	2014-08-18 18:55:12 +02:00
man	Replaced django-admin.py with django-admin in the man page.	2014-07-31 23:46:49 +02:00
misc
ref	Fixed #5726 -- Documented that inspectdb doesn't detect defaults.	2014-08-19 06:14:14 -04:00
releases	Fixed #18355 -- Added ordering options to list based generic views.	2014-08-15 11:09:47 -04:00
topics	Fixed some doc errors that caused syntax highlighting to fail.	2014-08-18 20:37:47 -04:00
conf.py
contents.txt
glossary.txt
index.txt	Introduced a technical board.	2014-08-01 14:41:24 +02:00
make.bat
Makefile
README
spelling_wordlist	Added some words to spelling_wordlist.	2014-08-14 14:13:08 -04: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 ``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/