mirrors
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues 24 Releases Wiki Activity
django/docs
History
Michal Petrucha 86e149ae05 Fixed a typo in the Python 3 compatibility docs. 2012-09-08 18:54:33 +02:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs Fixed #13616 - Updated the documentation to be compatible with Sphinx 1.0. 2010-07-24 10:21:21 +00:00
faq Avoided mixing dates and datetimes in the examples. 2012-09-08 11:00:04 -04:00
howto Fixed #15566 - Documented that update() doesn't honor DateField.auto_now 2012-09-08 06:38:41 -04:00
internals Fixed #18054 -- Deprecated contrib.markup. Thanks to simukis for the initial patch. 2012-09-08 12:13:46 -04:00
intro Avoided mixing dates and datetimes in the examples. 2012-09-08 11:00:04 -04:00
man Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review. 2012-04-08 21:13:32 +00:00
misc Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
obsolete Fixed #14141: docs now use the :doc: construct for links between documents. 2010-08-19 19:27:44 +00:00
ref Updated docs for dates generic views. 2012-09-08 12:22:39 -04:00
releases Fixed #18054 -- Deprecated contrib.markup. Thanks to simukis for the initial patch. 2012-09-08 12:13:46 -04:00
topics Fixed a typo in the Python 3 compatibility docs. 2012-09-08 18:54:33 +02:00
Makefile Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30
conf.py Added latex preamble for ≤. 2012-08-28 22:45:51 +02:00
contents.txt Fixed #13397 - Include third level headings in the TOC. thanks cyang for the suggestion, rleland for the patch. 2010-12-27 23:58:16 +00:00
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt Fixed #17378 - Added a flattened index for class-based views. 2012-09-01 09:20:38 -04:00
make.bat Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00: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/