1
0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
django/docs
2014-11-11 16:41:09 +01:00
..
_ext
_theme
faq Fixed #23527 -- Removed Cheetah references in docs 2014-09-21 18:03:31 +02:00
howto Fixed versionchanged indentation in docs/. 2014-11-03 21:40:26 -05:00
internals Added "Features removed in 1.8" section to release notes. 2014-11-05 09:08:09 -05:00
intro Replaced dead links to python-distribute.org. 2014-10-24 18:58:31 -04:00
man
misc
ref Fixed #23789 -- TemplateResponse handles context differently from render 2014-11-10 14:47:45 +00:00
releases Fixed spelling errors in docs. 2014-11-11 16:41:09 +01:00
topics Fixed spelling errors in docs. 2014-11-11 16:41:09 +01:00
conf.py Removed simplejson inventory file from docs/conf.py. 2014-10-25 07:31:12 +03:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Moved CSRF docs out of contrib. 2014-11-03 07:47:39 -05:00
make.bat
Makefile
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist Fixed spelling errors in docs. 2014-11-11 16:41:09 +01:00

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 ``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/