django

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

History

Tim Graham 3004d7057f Refs #27753 -- Removed django.utils.functional.curry().		2019-02-05 13:00:15 -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	Added stub release notes for 3.0.	2019-01-17 10:50:25 -05:00
howto	Fixed #30116 -- Dropped support for Python 3.5.	2019-01-30 10:19:48 -05:00
internals	Refs #27753 -- Removed django.utils.six.	2019-02-05 12:58:55 -05:00
intro	Fixed #30116 -- Dropped support for Python 3.5.	2019-01-30 10:19:48 -05:00
man	Updated man page for Django 2.2 alpha.	2019-01-17 16:25:02 +01:00
misc
ref	Refs #27753 -- Removed django.utils.six.	2019-02-05 12:58:55 -05:00
releases	Refs #27753 -- Removed django.utils.functional.curry().	2019-02-05 13:00:15 -05:00
topics	Used LoginRequiredMixin in "Models and request.user" example.	2019-01-31 18:01:53 -05:00
conf.py	Used extlinks for GitHub commits.	2019-02-01 21:42:48 +01: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	Removed unused words from docs/spelling_wordlist.	2019-02-02 15:36:20 +01: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/