django

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

History

Tim Graham bcc3d2b978 Fixed #22818 -- Clarified you need to cd into the Django clone. Thanks Josh Parris.		2014-06-12 10:19:03 -04:00
..
_ext	Removed duplicate "Deprecated in Django A.B" text in docs.	2014-06-06 20:31:23 -04:00
_theme	Removed duplicate "Deprecated in Django A.B" text in docs.	2014-06-06 20:31:23 -04:00
faq	Fixed #3711 , #6734 , #12581 -- Bounded connection.queries.	2014-06-07 14:37:43 +02:00
howto	Added link to data migrations in initial data deprecation note	2014-06-11 19:46:57 +01:00
internals	Fixed #22818 -- Clarified you need to cd into the Django clone.	2014-06-12 10:19:03 -04:00
intro	Fixed #22801 -- Added 'www.' to diveintopython.net links	2014-06-10 15:38:25 -04:00
man
misc
ref	Fixed #22811 -- Allowed setting both the old and new TEST database settings.	2014-06-12 08:17:49 -04:00
releases	Fixed #22811 -- Allowed setting both the old and new TEST database settings.	2014-06-12 08:17:49 -04:00
topics	Fixed #22801 -- Added 'www.' to diveintopython.net links	2014-06-10 15:38:25 -04:00
conf.py	Fixed #17238 -- Added source code links to docs using sphinx.ext.viewcode.	2014-06-07 08:54:54 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist	Doc edits for refs #22487 .	2014-06-09 12:09:16 -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 ``sudo 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/