django

mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00

History

Alex Gaynor bb5ab908cc Fixed a typo in the documentation		2013-11-26 13:49:54 -06:00
..
_ext	Fixed all E226 violations	2013-11-03 10:08:55 -08: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	Fixed #21479 -- Favor 'migrate' over 'syncdb' in the docs.	2013-11-21 15:12:39 +01:00
internals	Fixed some unnescesarily gendered language in the docs	2013-11-24 21:05:59 -06:00
intro	Fixed #21479 -- Favor 'migrate' over 'syncdb' in the docs.	2013-11-21 15:12:39 +01:00
man
misc	Whitespace cleanup.	2013-10-10 16:49:20 -04:00
ref	Fixed a typo in the documentation	2013-11-26 13:49:54 -06:00
releases	Fixed #21448 -- Fixed test client logout with cookie-based sessions	2013-11-26 20:41:51 +01:00
topics	Fixed some unnescesarily gendered language in the docs	2013-11-24 21:05:59 -06:00
conf.py	Fixed all E261 warnings	2013-11-02 18:20:39 -04:00
contents.txt
glossary.txt
index.txt	Fixed #21213 -- Added docs for Django's mailing lists.	2013-10-04 10:00:36 -04:00
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/