django/docs
Tim Graham 038ea4f859
Fixed #28966 -- Doc'd that the uuid URL path converter requires dashes
2017-12-27 12:23:44 -05:00
..
_ext Fixed #28860 -- Removed unnecessary len() calls. 2017-12-04 10:35:23 -05:00
_theme Clarified QuerySet.iterator()'s docs on server-side cursors. 2017-06-01 15:38:30 -04:00
faq Fixed #27855 -- Updated docs for Python 3.4 support in Django 2.0. 2017-08-11 11:17:08 -04:00
howto Fixed #28594 -- Removed Jython docs and specific code 2017-12-23 10:26:32 +01:00
internals Fixed #28929 -- Corrected QUnit examples. 2017-12-18 09:49:00 -10:00
intro Fixed #28594 -- Removed Jython docs and specific code 2017-12-23 10:26:32 +01:00
man Updated man page for Django 2.0 alpha. 2017-09-22 12:28:56 -04:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref Fixed #28956 -- Updated admin's jQuery to 3.2.1. 2017-12-26 10:21:05 -05:00
releases Fixed #28944 -- Fixed crash when chaining values()/values_list() after QuerySet.select_for_update(of=()). 2017-12-26 11:41:17 -05:00
topics Fixed #28966 -- Doc'd that the uuid URL path converter requires dashes 2017-12-27 12:23:44 -05:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Fixed #28963 -- Raised minimum Sphinx version. 2017-12-25 14:17:09 -03:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #28594 -- Removed Jython docs and specific code 2017-12-23 10:26:32 +01:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Removed unused words from docs/spelling_wordlist. 2017-11-24 07:53:40 -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/