django

mirror of https://github.com/django/django.git synced 2024-12-24 18:16:19 +00:00

History

Tim Graham f3e7ab366c Removed gender-based pronouns per [`c0a2daad78`].		2013-11-30 08:37:15 -05:00
..
_ext	Replace use of dict.has_key with `key in dict`	2013-11-26 14:32:14 -06:00
_theme/djangodocs	Fixed #20910 -- Added a "snippet" sphinx directive to allow prefixing a filename.	2013-10-14 13:00:57 -04:00
faq	Fixed #21479 -- Favor 'migrate' over 'syncdb' in the docs.	2013-11-21 15:12:39 +01:00
howto	Field.deconstruct() howto docs	2013-11-27 15:20:53 +00:00
internals	Documented the house style for gender neutral pronouns.	2013-11-30 08:31:58 -05:00
intro	Update tutorial part 1 to discuss migrations properly	2013-11-27 16:29:49 +00:00
man	Enabled makemessages to support several translation directories	2013-11-30 11:00:23 +01:00
misc	Whitespace cleanup.	2013-10-10 16:49:20 -04:00
ref	Removed gender-based pronouns per [`c0a2daad78`].	2013-11-30 08:37:15 -05:00
releases	Removed gender-based pronouns per [`c0a2daad78`].	2013-11-30 08:37:15 -05:00
topics	Removed gender-based pronouns per [`c0a2daad78`].	2013-11-30 08:37:15 -05:00
conf.py	Fixed all E261 warnings	2013-11-02 18:20:39 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README	Whitespace cleanup.	2013-10-10 16:49: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 ``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/