django

mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00

History

wrwrwr 34a06d99e0 Cleaned up a note in docs/topics/db/sql.txt.		2014-12-06 09:25:48 -05:00
..
_ext	Added sphinx extension to ease generation of ticket links.	2014-08-19 17:40:50 -04:00
_theme	Added newlines to the ends of CSS, HTML, and JavaScript files missing them.	2014-08-12 19:22:09 -04:00
faq	Added 1.9/removed 1.5 on Python version support table.	2014-11-28 09:17:00 -05:00
howto	Removed redundant numbered parameters from str.format().	2014-12-03 14:27:38 -05:00
internals	Fixed #23957 -- Started deprecation toward requiring session verification.	2014-12-05 07:37:34 -05:00
intro	Removed redundant numbered parameters from str.format().	2014-12-03 14:27:38 -05:00
man	Fixed #18714 -- Added 'fuzzy' compilemessages option	2014-11-18 22:44:16 +01:00
misc
ref	Fixed typo in docs/ref/applications.txt.	2014-12-06 09:22:46 -05:00
releases	Fixed #23957 -- Started deprecation toward requiring session verification.	2014-12-05 07:37:34 -05:00
topics	Cleaned up a note in docs/topics/db/sql.txt.	2014-12-06 09:25:48 -05:00
conf.py	Updated formtools docs to point at new package outside the Django repo.	2014-11-26 09:41:52 -05:00
contents.txt
glossary.txt	Fixed some intersphinx references.	2014-10-16 20:00:17 -04:00
index.txt	Updated formtools docs to point at new package outside the Django repo.	2014-11-26 09:41:52 -05:00
make.bat
Makefile
README	Removed sudo from pip commands in docs.	2014-09-22 15:49:48 -04:00
spelling_wordlist	Fixed spelling in docs/ref/django-admin.txt.	2014-11-24 08:32:07 -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/