Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
..
Failed to load latest commit information.
_ext Fixed E265 comment style
_theme Optimise the rest of the PNGs in docs
faq Removed Django 1.6 from the Python version chart.
howto Fixed #17085, #24783 -- Refactored template library registration.
internals Added oss-security@lists.openwall.com to security release announcements.
intro Optimise tutorial images
man Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage
misc Fixed #16785 -- Documented some of the design decisions of the cache …
ref Fixed #24880 -- Added more explicit docs on select_for_update() on SQ…
releases Fixed #24604 -- Added JSONField to contrib.postgres.
topics Simplified wording in QuerySet.update() docs.
Makefile Added an "htmlview" target to open docs after building them.
README Removed sudo from pip commands in docs.
conf.py Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage
contents.txt Removed an obsolete documentation page about admin style customization.
glossary.txt Fixed some intersphinx references.
index.txt Fixed #24732 -- Reordered tutorial to cover basics before bells and w…
make.bat Fixed #19516 - Fixed remaining broken links.
spelling_wordlist Updated capitalization in the word "JavaScript" for consistency

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/
Something went wrong with that request. Please try again.