Find file History
..
Failed to load latest commit information.
_ext Added copy-to-clipboard support for all code snippets Jul 6, 2016
_theme Fixed many spelling mistakes in code, comments, and docs. Dec 3, 2015
faq Fixed #26894 -- Fixed a typo in docs/faq/admin.txt Jul 14, 2016
howto Removed extra periods in docs/howto/static-files/index.txt headers. Jul 27, 2016
internals Fixed #22446 -- Added tox.ini to automate pull request checks. Jul 20, 2016
intro Reworded a sentence in tutorial 7. Jul 14, 2016
man Discouraged use of /tmp with predictable names. Dec 24, 2015
misc Fixed #26020 -- Normalized header stylings in docs. Jan 22, 2016
ref Fixed #26946 -- Clarified instructions for customizing collectstatic'… Jul 25, 2016
releases Fixed #26946 -- Clarified instructions for customizing collectstatic'… Jul 25, 2016
topics Fixed #26925 -- Linked aggregation ordering topic from Meta.ordering … Jul 25, 2016
Makefile Added an "htmlview" target to open docs after building them. Dec 8, 2014
README Removed sudo from pip commands in docs. Sep 22, 2014
conf.py Ignored new warnings when building the docs with Sphinx 1.4. Jun 1, 2016
contents.txt Fixed #26020 -- Normalized header stylings in docs. Jan 22, 2016
glossary.txt Fixed #26020 -- Normalized header stylings in docs. Jan 22, 2016
index.txt Fixed #26709 -- Added class-based indexes. Jun 27, 2016
make.bat Fixed #19516 - Fixed remaining broken links. Jan 2, 2013
spelling_wordlist Fixed #22446 -- Added tox.ini to automate pull request checks. Jul 20, 2016

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/