0
0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
django/docs
Tim Graham 4669986228 Merge pull request #1378 from loic/docs
Fixed #20772 -- Fixed minor typo in form media docs.
2013-07-19 02:19:24 -07:00
..
_ext Replaced and...or... constructs with PEP 308 conditional expressions. 2013-05-26 23:47:50 -03:00
_theme/djangodocs Fixed #18789 - Fixed some text wrap issues with methods in the docs. 2013-02-19 10:25:26 -05:00
faq Fixed #19695 -- Retitle "Form Media" to "Form Assets". 2013-07-08 13:59:54 -04:00
howto Fixed #20756 -- Typo in uWSGI docs. 2013-07-17 06:50:40 -04:00
internals Rephrased the docs for reporting security issues to make it less intimidating. 2013-07-16 17:17:08 +07:00
intro Fixed #20763 -- Typo in tutorial 3. 2013-07-18 07:58:51 -04:00
man Revert "Patch by Claude for #16084." 2013-01-25 13:58:37 -03:00
misc Fixed #19728 - Updated API stability doc to reflect current meaning of "stable". 2013-02-19 18:19:50 -05:00
ref Atom specification URL updated 2013-07-18 12:53:54 +01:00
releases Allowed Context.push to behave as a context mananger. 2013-07-17 13:32:32 -04:00
topics Merge pull request #1378 from loic/docs 2013-07-19 02:19:24 -07:00
conf.py Master is now pre-1.7. 2013-06-28 08:56:45 -05:00
contents.txt
glossary.txt
index.txt Updated test failure example. 2013-05-12 17:29:34 -03:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Allow build of translated documentation 2013-06-08 16:13:51 +02: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.pocoo.org/