django

mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00

History

Tim Graham d3bf5e7b00 Fixed #24645 -- Documented use of HStoreExtension.		2015-04-16 07:22:01 -04:00
..
_ext	Fixed E265 comment style	2015-02-06 09:30:35 -05:00
_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 #24645 -- Documented use of HStoreExtension.	2015-04-16 07:22:01 -04:00
releases	Fixed #24615 -- ordering by expression not part of SELECT	2015-04-16 09:40:47 +02:00
topics	Removed docs for removed transaction APIs.	2015-04-14 13:52:45 -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	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/