mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
Code Issues Releases Wiki Activity
8ca3963ab2
django/docs
History
DanSears 8ca3963ab2 Clarified MySQL Connector note.
2013-11-15 08:51:17 -05:00
..
_ext Fixed all E226 violations 2013-11-03 10:08:55 -08: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 #8918 -- Made FileField.upload_to optional. 2013-10-11 08:07:25 -04:00
howto Fixed #20962 -- Documented that template tag render() may raise exceptions. 2013-10-14 11:53:15 -04:00
internals Fixed #21351 -- Replaced memoize with Python's lru_cache. 2013-11-11 08:53:09 +01:00
intro Fixed typo in tutorial 2; refs #21418. 2013-11-10 06:10:13 -05:00
man
misc Whitespace cleanup. 2013-10-10 16:49:20 -04:00
ref Clarified MySQL Connector note. 2013-11-15 08:51:17 -05:00
releases Added backported fixes to 1.6.1 release notes. 2013-11-14 23:13:20 +01:00
topics Fixed #21425 -- Made order in which loggers are introduced consistent. 2013-11-15 08:39:40 -05:00
conf.py Fixed all E261 warnings 2013-11-02 18:20:39 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
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/