1
0
mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00
django/docs
2012-08-05 22:53:09 +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
internals
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 Fixed a rst error introduced in f2abfe1e. 2012-08-05 22:53:09 +02:00
releases
topics Merge pull request #153 from webjunkie/patch-1 2012-08-04 12:50:42 -07:00
conf.py
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/