1
0
mirror of https://github.com/django/django.git synced 2024-12-26 02:56:25 +00:00
django/docs
Aymeric Augustin a120fac65a Introduced force_bytes and force_str.
This is consistent with the smart_* series of functions and it's going
to be used by the next commit.
2012-08-18 16:38:49 +02:00
..
_ext
_theme/djangodocs
faq Moved a note about django-admin.py errors from Tutorial Part 1 to a new FAQ Troubleshooting page. This is to avoid confusion for beginners. 2012-08-04 17:27:57 -07:00
howto [py3] Ported django.utils.safestring. 2012-08-18 16:04:06 +02:00
internals Removed missplaced label in the docs. 2012-08-12 12:43:05 +02:00
intro Added a warning about the {% url %} syntax change 2012-08-18 09:58:42 +02:00
man
misc Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
obsolete
ref Introduced force_bytes and force_str. 2012-08-18 16:38:49 +02:00
releases Fixed #17228 -- params context variable is inconsistent 2012-08-18 15:07:21 +01:00
topics [py3] Added compatibility import of thread/_thread 2012-08-18 10:56:56 +02:00
conf.py Fixed #18698 -- Configure latex to support '≥' in the docs. 2012-08-11 21:48:11 +02:00
contents.txt
glossary.txt Fixed #18451 -- Vastly improved class based view documentation. 2012-06-11 10:40:23 +02:00
index.txt And link security policies from documentation index. 2012-08-07 16:26:37 -04:00
make.bat
Makefile
README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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/