django/docs
Baptiste Mispelon 76e0846c90 [3.0.x] Fixed #28469 -- Doc'd how to create a custom HttpResponse subclass.
Backport of 9f1ec9efc3 from master
2019-11-25 08:35:33 +01:00
..
_ext [3.0.x] Made versionadded/versionchanged annotations without a content end with ".". 2019-11-21 09:03:44 +01:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq [3.0.x] Refs #29926 -- Doc'd Python 3.8 compatibility in Django 2.2.x. 2019-11-12 22:13:54 +01:00
howto [3.0.x] Fixed #30999 -- Fixed typo in docs/howto/custom-template-tags.txt. 2019-11-19 10:09:27 +01:00
internals [3.0.x] Pinned asgiref to 3.2 series. 2019-11-20 15:13:28 +01:00
intro [3.0.x] Fixed #30944 -- Changed reusable apps docs to use a declarative config. 2019-11-05 15:01:42 +01:00
man [3.0.x] Updated man page for Django 3.0 release candidate 1. 2019-11-18 09:27:41 +01:00
misc [3.0.x] Expanded API stability docs to include our policy of continual improvement. 2019-11-18 21:39:30 +01:00
ref [3.0.x] Fixed #28469 -- Doc'd how to create a custom HttpResponse subclass. 2019-11-25 08:35:33 +01:00
releases [3.0.x] Fixed #31012 -- Reverted "Fixed #29056 -- Fixed HTML5 validation of required SelectDateWidget." 2019-11-21 21:06:07 +01:00
topics [3.0.x] Fixed #31008 -- Fixed typos in docs/topics/logging.txt. 2019-11-20 20:36:20 +01:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02:00
conf.py [3.0.x] Bumped next Django version in docs config. 2019-09-10 10:34:38 +02: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 #30767 -- Improved references to deployment documentation. 2019-09-09 10:02:33 +02:00
make.bat
spelling_wordlist Fixed #27910 -- Added enumeration helpers for use in Field.choices. 2019-09-04 14:42:49 +02: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 ``python -m 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/