1
0
mirror of https://github.com/django/django.git synced 2025-01-10 18:36:05 +00:00
django/docs
2016-06-02 19:42:08 -04:00
..
_ext
_theme
faq
howto Removed versionadded/changed annotations for 1.9. 2016-05-20 11:44:29 -04:00
internals Added a ticket tracker link in docs/internals/contributing/bugs-and-features.txt 2016-06-02 16:03:29 -04:00
intro Fixed #26483 -- Updated docs.python.org links to use Intersphinx. 2016-05-08 18:07:43 -04:00
man
misc
ref Fixed #26526 -- Documented QuerySet.latest()'s dependency on database ordering. 2016-06-02 19:42:08 -04:00
releases Fixed #26672 -- Fixed HStoreField to raise ValidationError instead of crashing on non-dict JSON input. 2016-06-02 16:28:01 -04:00
topics Fixed #26337 -- Added i18n note about using a non-English base language 2016-06-02 20:56:31 +02: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
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/