django/docs
Tim Graham 2fbea621e6 Capitalized "Python" in docs. 2015-06-05 08:24:53 -04:00
..
_ext Fixed E265 comment style 2015-02-06 09:30:35 -05:00
_theme Optimise the rest of the PNGs in docs 2015-05-29 15:22:40 +10:00
faq Removed Django 1.6 from the Python version chart. 2015-04-02 14:21:01 -04:00
howto Fixed #24926 -- Removed outdated information from deployment 2015-06-05 12:03:29 +02:00
internals Capitalized "Python" in docs. 2015-06-05 08:24:53 -04:00
intro Fixed #7060 -- Added a note about race conditions to the tutorial 2015-06-04 09:40:59 -04:00
man Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
misc
ref Capitalized "Python" in docs. 2015-06-05 08:24:53 -04:00
releases Capitalized "Python" in docs. 2015-06-05 08:24:53 -04:00
topics Capitalized "Python" in docs. 2015-06-05 08:24:53 -04:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Fixed #24732 -- Reordered tutorial to cover basics before bells and whistles. 2015-05-28 14:07:39 -04:00
make.bat
spelling_wordlist Fixed #24230 -- Added translated language name for i18n template tag/filter. 2015-06-02 16:04:01 -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 ``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/