1
0
mirror of https://github.com/django/django.git synced 2024-12-26 11:06:07 +00:00
django/docs
Aymeric Augustin c5ef65bcf3 [py3] Ported django.utils.encoding.
* Renamed smart_unicode to smart_text (but kept the old name under
  Python 2 for backwards compatibility).
* Renamed smart_str to smart_bytes.
* Re-introduced smart_str as an alias for smart_text under Python 3
  and smart_bytes under Python 2 (which is backwards compatible).
  Thus smart_str always returns a str objects.
* Used the new smart_str in a few places where both Python 2 and 3
  want a str.
2012-08-07 12:00:22 +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.encoding. 2012-08-07 12:00:22 +02:00
internals Reinstated Pinax link that was still in use by others. 2012-08-02 20:27:53 +10:00
intro 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
man
misc
obsolete
ref [py3] Ported django.utils.encoding. 2012-08-07 12:00:22 +02:00
releases [py3] Ported django.utils.encoding. 2012-08-07 12:00:22 +02:00
topics [py3] Ported django.utils.encoding. 2012-08-07 12:00:22 +02:00
conf.py [py3] Documented coding guidelines for Python 3. 2012-07-22 10:29:07 +02:00
contents.txt
glossary.txt
index.txt Fixed some typos on the documentation's index page. 2012-08-04 18:19:25 -07: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/