django

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

History

David Hoffman 03467368db Fixed #23558 -- documented slugify limitations		2014-10-30 09:02:04 -04: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 #23493 -- Added bilateral attribute to Transform	2014-10-28 10:02:10 +02:00
internals	Fixed spelling errors in docs.	2014-10-28 10:15:52 -04:00
intro	Replaced dead links to python-distribute.org.	2014-10-24 18:58:31 -04:00
man	Replaced django-admin.py with django-admin in the man page.	2014-07-31 23:46:49 +02:00
misc	Fixed #16785 -- Documented some of the design decisions of the cache framework.	2014-01-16 21:13:08 -05:00
ref	Fixed #23558 -- documented slugify limitations	2014-10-30 09:02:04 -04:00
releases	Fixed #23614 -- Changed the way the migration autodetector orders unique/index_together	2014-10-29 13:05:42 -04:00
topics	Fixed #18731 -- Added an example about customizing "makemessages" command.	2014-10-30 08:22:13 -04:00
conf.py	Removed simplejson inventory file from docs/conf.py.	2014-10-25 07:31:12 +03:00
contents.txt
glossary.txt	Fixed some intersphinx references.	2014-10-16 20:00:17 -04:00
index.txt	Fixed #17101 -- Integrated django-secure and added check --deploy option	2014-09-12 15:05:23 -04: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 errors in docs.	2014-10-28 10:15:52 -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/