django

mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00

History

Tim Graham f47c796b52 Fixed #24657 -- Fixed include template tag example. Thanks pattypatpat for the report.		2015-04-17 07:53:57 -04:00
..
_ext
_theme
faq	Removed Django 1.6 from the Python version chart.	2015-04-02 14:21:01 -04:00
howto	Fixed typo in docs/howto/deployment/wsgi/apache-auth.txt	2015-04-13 07:50:23 -04:00
internals	Removed docs for removed transaction APIs.	2015-04-14 13:52:45 -04:00
intro	Fixed typo in docs/intro/tutorial02.txt	2015-04-07 07:41:05 -04:00
man	Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage	2015-03-10 08:12:09 -04:00
misc
ref	Fixed #24657 -- Fixed include template tag example.	2015-04-17 07:53:57 -04:00
releases	Fixed #24595 -- Prevented loss of null info in MySQL field alteration	2015-04-17 10:25:15 +02:00
topics	Fixed #24646 -- Fixed jinja2 example on Python 2.	2015-04-16 19:32:42 -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
README
spelling_wordlist	Refs #24568 -- Added Read the Docs step to the release checklist.	2015-04-09 10:07:20 -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/