mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-09-12 05:26:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
django/docs
History
Jannis Leidel 02ac44b29a [1.5.x] Fixed #20774 -- Mention the new django-localflavor app as a replacement for the contrib app. Backport from master.
2013-07-29 10:55:50 +02:00
..
_ext
_theme/djangodocs
faq
howto [1.5.x] Fixed #20756 -- Typo in uWSGI docs. 2013-07-17 06:51:42 -04:00
internals [1.5.x] Added a missing test requirement in the docs; refs #19196 2013-07-10 12:10:26 -04:00
intro [1.5.x] Fixed #20763 -- Typo in tutorial 3. 2013-07-18 08:05:06 -04:00
man
misc
ref [1.5.x] Fixed #20774 -- Mention the new django-localflavor app as a replacement for the contrib app. Backport from master. 2013-07-29 10:55:50 +02:00
releases [1.5.x] Fixed #18944 -- Documented PasswordResetForm's from_email argument as a backwards incompatible change for 1.3 2013-07-08 15:06:37 -04:00
topics [1.5.x] Fixed ReST typo in topics/class-based-views/mixins.txt 2013-07-28 14:10:25 -04:00
conf.py [1.5.x] Allow build of translated documentation 2013-06-08 16:14:45 +02:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile [1.5.x] Allow build of translated documentation 2013-06-08 16:14:45 +02:00
README

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.pocoo.org/