django

mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00

History

Simon Charette c5b58d7767 Refs #29928 -- Adjusted release notes of SQLite test constraint checking.		2018-12-22 14:32:40 -05: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	Refs #28814 -- Doc'd Python 3.7 compatibility in Django 1.11.x.	2018-11-17 15:40:35 -05:00
howto	Fixed #29895 -- Doc'd why MySQL's atomic DDL statements don't work for atomic migrations.	2018-12-06 16:03:02 -05:00
internals	Used auto-numbered lists in documentation.	2018-11-15 13:54:28 -05:00
intro	Used auto-numbered lists in documentation.	2018-11-15 13:54:28 -05:00
man
misc
ref	Fixed #29750 -- Added View.setup() hook for class-based views.	2018-12-21 19:01:11 -05:00
releases	Refs #29928 -- Adjusted release notes of SQLite test constraint checking.	2018-12-22 14:32:40 -05:00
topics	Fixed #29750 -- Added View.setup() hook for class-based views.	2018-12-21 19:01:11 -05:00
conf.py	Removed obsolete html_use_smartypants Sphinx option.	2018-09-18 11:51:04 -04:00
contents.txt
glossary.txt
index.txt	Removed dead links to botbot.me.	2018-11-10 17:25:10 -05:00
make.bat
Makefile
README
spelling_wordlist

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/