django

mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00

History

Jannis Leidel 6302893112 Updated formtools docs to point at new package outside the Django repo. Refs #23677.		2014-11-26 09:41:52 -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	Fixed #23527 -- Removed Cheetah references in docs	2014-09-21 18:03:31 +02:00
howto	Fixed #23543 -- Added docs on testing management command output.	2014-11-24 10:23:25 -05:00
internals	Updated formtools docs to point at new package outside the Django repo.	2014-11-26 09:41:52 -05:00
intro	Fixed #23907 -- Added admin.site.register in tutorial 2 for consistency.	2014-11-24 15:58:56 -05:00
man	Fixed #18714 -- Added 'fuzzy' compilemessages option	2014-11-18 22:44:16 +01:00
misc	Fixed #16785 -- Documented some of the design decisions of the cache framework.	2014-01-16 21:13:08 -05:00
ref	Updated formtools docs to point at new package outside the Django repo.	2014-11-26 09:41:52 -05:00
releases	Updated formtools docs to point at new package outside the Django repo.	2014-11-26 09:41:52 -05:00
topics	Fixed #23742 -- Added an option to reverse tests order.	2014-11-24 19:24:11 -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	Fixed #22141 -- Added a spelling checker for documentation.	2014-03-07 09:29:23 -05:00
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/