mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-17 17:20:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
django/docs
History
Jon Dufresne 490f4fa574 [2.1.x] Corrected docs to say that all templates are text strings. 
Support for bytestring templates was removed in
3a148f958d.
Backport of 3212008ba6 from master
2018-10-03 10:06:32 +02:00
..
_ext [2.1.x] Fixed crash building translated docs since Sphinx 1.8. 2018-10-01 20:44:57 -04:00
_theme [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 14:38:08 -04:00
faq [2.1.x] Refs #28814 -- Documented Python 3.7 compatibility. 2018-06-28 11:05:32 -04:00
howto [2.1.x] Emphasized that TemplatesSetting must be used to override widget templates. 2018-09-11 15:15:14 -04:00
internals [2.1.x] Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 14:38:08 -04:00
intro [2.1.x] Updated contributing tutorial's virtual environment instructions. 2018-09-19 15:04:53 -04:00
man Updated man page for Django 2.1 alpha. 2018-05-17 09:30:20 -04:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref [2.1.x] Corrected docs to say that all templates are text strings. 2018-10-03 10:06:32 +02:00
releases [2.1.x] Adjusted text for CVE-2018-16984 in security release archive. 2018-10-01 15:05:28 +02:00
topics [2.1.x] Fixed #29758 -- Documented how to test custom error views. 2018-10-01 18:39:11 -04:00
conf.py [2.1.x] Bumped django_next_version in sphinx config to 2.2. 2018-05-17 20:49:30 -04: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 #28594 -- Removed Jython docs and specific code 2017-12-23 10:26:32 +01:00
make.bat
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist [2.1.x] Fixed typos in comments and docs. 2018-08-01 16:13:18 -04: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/