mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity
7477a4ffde
django/docs
History
Baptiste Mispelon 077af42139 Fixed #21515 -- Corrected example of template.Context in documentation. 
Thanks to trac user oubiga for the report.
2013-11-28 00:57:13 +01: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 Fixed some unnescesarily gendered language in the docs 2013-11-24 21:05:59 -06:00
intro Update tutorial part 1 to discuss migrations properly 2013-11-27 16:29:49 +00:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc Whitespace cleanup. 2013-10-10 16:49:20 -04:00
ref Fixed #21515 -- Corrected example of template.Context in documentation. 2013-11-28 00:57:13 +01:00
releases Fixed typo in release notes. 2013-11-28 01:37:21 +07:00
topics Added a warning regarding risks in serving user uploaded media. 2013-11-27 16:35:25 -05: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 Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
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/