django/docs
Tim Graham 5418af7a78 [1.10.x] Fixed typo in docs/topics/testing/tools.txt.
Backport of 545a88fc16 from master
2017-02-08 12:34:51 -05:00
..
_ext [1.10.x] Fixed missing versionadded/changed annotations on docs.djangoproject.com. 2016-12-14 14:46:14 -05:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq [1.10.x] Replaced "django" with "Django" in spelling_wordlist. 2016-11-15 17:32:16 -05:00
howto [1.10.x] Added missing word in docs/howto/error-reporting.txt. 2017-01-30 15:39:40 -05:00
internals [1.10.x] Refs #24154 -- Added check_aggregate_support() to deprecation timeline. 2016-12-31 14:06:18 -05:00
intro [1.10.x] Fixed #26708 -- Updated the contributing tutorial to use a GitHub workflow. 2017-01-28 12:58:27 -05:00
man [1.10.x] Updated man page for Django 1.10 alpha. 2016-05-20 06:49:36 -04:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref [1.10.x] Fixed #27821 -- Clarified docs of the return value of Form.clean_<fieldname>(). 2017-02-08 08:39:39 -05:00
releases [1.10.x] Fixed #27805 -- Fixed ClearableFileInput's "Clear" checkbox on model fields with a default. 2017-02-06 21:10:44 -05:00
topics [1.10.x] Fixed typo in docs/topics/testing/tools.txt. 2017-02-08 12:34:51 -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.10.x] Removed deprecated html_translator_class sphinx config option. 2016-12-08 13:20:54 -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 Refs #3254 -- Added full text search to contrib.postgres. 2016-04-22 10:44:37 +01:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
spelling_wordlist [1.10.x] Fixed #27439 -- Documented macOS locale configuration for Django tests. 2016-12-20 13:21:18 -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/