django

mirror of https://github.com/django/django.git synced 2024-11-18 07:26:04 +00:00

History

Tim Graham 3d14cbc867 Removed docs/internals/roles.txt. It's moved to https://www.djangoproject.com/foundation/teams/.		2017-02-15 09:31:41 +01:00
..
_ext	Refs #23919 -- Replaced super(ClassName, self) with super() in docs.	2017-01-25 11:53:05 -05:00
_theme
faq	Fixed spelling of "nonexistent".	2017-02-03 08:01:45 -05:00
howto	Fixed #27823 -- Updated mod_wsgi example to use WSGIPythonHome.	2017-02-13 19:52:08 -05:00
internals	Removed docs/internals/roles.txt.	2017-02-15 09:31:41 +01:00
intro	Explained the shell's $ prefix in tutorial 1.	2017-02-09 09:33:42 -05:00
man
misc
ref	Refs #26610 -- Added CIText mixin and CIChar/Email/TextField.	2017-02-11 07:16:35 -05:00
releases	Fixed #27820 -- Fixed RequestDataTooBig/TooManyFieldsSent crash.	2017-02-13 16:19:03 -05:00
topics	Fixed #27367 -- Doc'd and tested reversing of URLs with the same name.	2017-02-11 08:58:40 -05:00
conf.py	Refs #23919 -- Removed Python 2 notes in docs.	2017-01-18 11:51:29 -05:00
contents.txt
glossary.txt
index.txt	Removed docs/internals/roles.txt.	2017-02-15 09:31:41 +01:00
make.bat
Makefile
README
spelling_wordlist	Fixed #15667 -- Added template-based widget rendering.	2016-12-27 17:50:10 -05: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/