0
0
mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00
django/docs
2017-06-20 22:59:22 -04:00
..
_ext Refs #23968 -- Removed unnecessary lists, generators, and tuple calls. 2017-06-01 19:08:59 -04:00
_theme Clarified QuerySet.iterator()'s docs on server-side cursors. 2017-06-01 15:38:30 -04:00
faq
howto Fixed #28327 -- Removed contradictory description of mod_wsgi docs. 2017-06-20 07:35:55 -04:00
internals Fixed #27655 -- Added some guidelines to the coding style docs. 2017-06-12 15:39:09 -04:00
intro Fixed #27953 -- Added instance's pk to Model.__str__(). 2017-06-09 13:42:53 -04:00
man
misc
ref Fixed typo in docs/ref/request-response.txt. 2017-06-20 11:22:26 -04:00
releases Refs #25530 -- Changed _create_index_name to take a table as first parameter. 2017-06-20 22:59:22 -04:00
topics Fixed #28233 -- Used a simpler example in the aggregation "cheat sheet" docs. 2017-06-06 16:11:48 -04:00
conf.py Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README
spelling_wordlist Fixed #28260 -- Allowed customizing the test tablespace initial and autoextend size on Oracle. 2017-06-02 18:35:56 +02: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/