0
0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
django/docs
2014-09-05 20:36:35 -04:00
..
_ext Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
_theme
faq
howto Fixed #23430 -- simplified gunicorn deployment docs. 2014-09-05 20:36:35 -04:00
internals Fixed #23414 -- Updated version numbers in release process doc. 2014-09-05 15:44:41 -04:00
intro Removed an admonition in the tutorial about the old project layout. 2014-09-05 14:43:33 -04:00
man
misc
ref Fixed #22534: Reinforce swappable documentation 2014-09-05 11:39:55 -07:00
releases Fixed #23427 -- Documented migrate is required before runserver for default projects. 2014-09-05 19:59:02 -04:00
topics Update docs to be more clear about nested classes (refs #23418) 2014-09-05 15:00:01 -07:00
conf.py Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist Added words to spelling_wordlist. 2014-08-26 09:44:07 -04: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 ``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-doc.org/