django/docs
Ryan Castner 76a99f1b9a [1.11.x] Added missing word in docs/howto/error-reporting.txt.
Backport of dbf79c5acf from master
2017-01-30 15:39:34 -05:00
..
_ext Fixed missing versionadded/changed annotations on docs.djangoproject.com. 2016-12-14 14:31:29 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq Removed the importance of "core developers" in triaging tickets, etc. 2016-12-21 20:18:13 -05:00
howto [1.11.x] Added missing word in docs/howto/error-reporting.txt. 2017-01-30 15:39:34 -05:00
internals Refs #24154 -- Added check_aggregate_support() to deprecation timeline. 2016-12-31 14:02:44 -05:00
intro [1.11.x] Fixed #26708 -- Updated the contributing tutorial to use a GitHub workflow. 2017-01-28 12:58:17 -05:00
man [1.11.x] Updated man page for Django 1.11 alpha. 2017-01-17 19:20:49 -05:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref [1.11.x] Fixed incorrect namespace in sitemap example. 2017-01-30 12:07:28 -05:00
releases Refs #27683 -- Allowed setting isolation level in DATABASES ['OPTIONS'] on MySQL. 2017-01-17 11:16:15 -05:00
topics [1.11.x] Fixed #27678 -- Warned that the template system isn't safe against untrusted authors. 2017-01-27 11:29:55 -05:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py [1.11.x] Bumped django_next_version in docs config. 2017-01-17 19:03:15 -05: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 #26709 -- Added class-based indexes. 2016-06-27 10:41:01 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist Fixed #15667 -- Added template-based widget rendering. 2016-12-27 17:50:10 -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/