mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-18 23:44:22 +00:00
Code Issues 24 Releases Wiki Activity
31f49f1396
django/docs
History
Tim Graham 31f49f1396 Fixed #19442 - Clarified that raw SQL must be committed. 
Thanks startup.canada for the suggestion.
2012-12-18 08:10:12 -05:00
..
_ext
_theme/djangodocs Fixed #19317 - Added an image for warning blocks in the docs 2012-11-22 06:34:15 -05:00
faq Fixed #19344 - Documented how to run django-admin in a virtualenv on Windows. 2012-12-15 09:25:54 -05:00
howto Fix typo in file storage docs. 2012-11-17 23:25:37 +01:00
internals Fixed #19389 -- Docs on the location of contrib apps tests. 2012-12-08 19:47:53 +01:00
intro Fixed #19344 - Documented how to run django-admin in a virtualenv on Windows. 2012-12-15 09:25:54 -05:00
man
misc Removes PHP references 2012-12-13 13:20:47 +00:00
ref Fixed #18718 - Documented django.utils.encoding.filepath_to_uri 2012-12-16 14:39:37 -05:00
releases Fixed #19384 -- Documented the behavior of custom managers on abstract models. 2012-12-15 22:44:46 +08:00
topics Fixed #19442 - Clarified that raw SQL must be committed. 2012-12-18 08:10:12 -05:00
conf.py Fixed two docstring/comment typos. 2012-11-28 20:28:30 -03: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 Fixed #9962 - Added a testing tutorial. 2012-12-15 08:09:40 -05:00
make.bat Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01:00
Makefile Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30

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/