django

mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00

History

Tim Graham 1b605838bf Added stub release notes for 1.8.1.		2015-04-01 16:08:15 -04:00
..
_ext	Fixed E265 comment style	2015-02-06 09:30:35 -05:00
_theme
faq	Removed compatibility with Python 3.2.	2015-01-17 09:00:17 -05:00
howto	Updated location of database backend data_types attribute in docs.	2015-03-17 20:03:07 -04:00
internals	Fixed #24215 -- Refactored lazy model operations	2015-03-25 16:48:17 -04:00
intro	Fixed #24550 -- Added migration operation description to sqlmigrate output	2015-03-30 16:31:20 +02:00
man	Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage	2015-03-10 08:12:09 -04:00
misc
ref	Fixed typo in docs/ref/templates/builtins.txt	2015-03-31 21:20:03 -04:00
releases	Added stub release notes for 1.8.1.	2015-04-01 16:08:15 -04:00
topics	Fixed typo in docs/topics/cache.txt	2015-03-31 21:15:56 -04:00
conf.py	Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage	2015-03-10 08:12:09 -04:00
contents.txt
glossary.txt
index.txt	Fixed #23814 -- Documented apps refactored out of Django.	2015-03-25 08:46:23 -04:00
make.bat
Makefile	Added an "htmlview" target to open docs after building them.	2014-12-08 07:23:34 -05:00
README
spelling_wordlist	Fixed #16362 -- Allowed lookaround assertions in URL patterns.	2015-03-23 09:00:07 -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 ``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/