django1/docs
Felipe Lee c2c27867ef Refs #20456 -- Moved initialization of HEAD method based on GET to the View.setup() for generic views.
This will ease unit testing of views since setup will essentially do
everything needed to set the view instance up (other than instantiating
it). Credit for idea goes to Vincent Prouillet.
2019-10-30 14:43:52 +01:00
..
_ext Fixed crash building translated docs since Sphinx 1.8. 2018-10-01 20:44:02 -04:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq Made minor edits and small fixes to docs/faq/install.txt. 2019-10-04 11:21:50 +02:00
howto Fixed #30906 -- Fixed an example of using the template system to generate CSV. 2019-10-25 08:11:11 +02:00
internals Fixed #30927 -- Simplified an example of test for the deprecation warning with assertWarnsMessage(). 2019-10-30 13:35:36 +01:00
intro Fixed #30816 -- Doc'd how to create projects with a local copy of Django. 2019-10-15 12:38:40 +02:00
man Updated man page for 3.0 alpha release. 2019-09-10 10:10:50 +02:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref Refs #20456 -- Moved initialization of HEAD method based on GET to the View.setup() for generic views. 2019-10-30 14:43:52 +01:00
releases Refs #28428 -- Made filepath_to_uri() support pathlib.Path. 2019-10-30 13:13:15 +01:00
topics Fixed #30917 -- Clarified formsets topic documentation. 2019-10-30 08:41:31 +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 Bumped version; master is now 3.1 pre-alpha. 2019-09-10 11:54:25 +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/