1
0
mirror of https://github.com/django/django.git synced 2024-12-24 01:55:49 +00:00
django/docs
Tim Graham eafc036476 Fixed #19577 - Added HTML escaping to admin examples.
Thanks foo@ for the report and Florian Apolloner for the review.
2013-01-25 06:53:40 -05:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs Addeded CSS to bold deprecation notices. 2013-01-09 19:03:34 -05:00
faq Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
howto Fixed #19633 - Discouraged use of gunicorn's Django integration. 2013-01-22 19:02:31 -05:00
internals Fixed #19639 - Updated contributing to reflect model choices best practices. 2013-01-24 07:59:39 -05:00
intro Fixed #19605 - Removed unused url imports from doc examples. 2013-01-15 07:50:26 -05:00
man
misc Removed django.contrib.localflavor. 2012-12-29 21:59:06 +01:00
ref Fixed #19577 - Added HTML escaping to admin examples. 2013-01-25 06:53:40 -05:00
releases Fixed #17813 -- Added a .earliest() method to QuerySet 2013-01-20 06:39:35 +02:00
topics Fixed #17416 -- Added widgets argument to inlineformset_factory and modelformset_factory 2013-01-24 08:58:17 +01:00
conf.py Fixed broken links, round 3. refs #19516 2012-12-26 19:07:22 -05:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Removed django.contrib.localflavor. 2012-12-29 21:59:06 +01:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30

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/