1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
Scott Vitale be729b6120 Fixed #10107 -- Allowed using mark_safe() as a decorator.
Thanks ArcTanSusan for the initial patch.
2016-06-07 12:24:03 -04:00
..
_ext
_theme
faq
howto Fixed #26713 -- Documented resolving deprecation warnings before upgrade. 2016-06-06 11:38:02 -04:00
internals Fixed #26701 -- Replaced /newticket links to Trac with /. 2016-06-03 08:48:12 -04:00
intro Documented known Python 3.5+ test failures in contributing tutorial. 2016-06-06 10:49:44 -04:00
man
misc
ref Fixed #10107 -- Allowed using mark_safe() as a decorator. 2016-06-07 12:24:03 -04:00
releases Fixed #10107 -- Allowed using mark_safe() as a decorator. 2016-06-07 12:24:03 -04:00
topics Fixed #25127 -- Documented how to organize models in a package. 2016-06-04 11:47:55 -04:00
conf.py Ignored new warnings when building the docs with Sphinx 1.4. 2016-06-01 11:03:41 -04:00
contents.txt
glossary.txt
index.txt Refs #3254 -- Added full text search to contrib.postgres. 2016-04-22 10:44:37 +01:00
make.bat
Makefile
README
spelling_wordlist Fixed #26646 -- Added IOBase methods required by TextIOWrapper to File. 2016-05-27 21:05:58 -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 ``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/