mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-27 11:35:53 +00:00
Code Issues 30 Releases Wiki Activity
ee2f0f311a
django/docs
History
Tim Graham ee2f0f311a Linked "Features removed" release notes to corresponding deprecation notes.
2016-07-11 15:22:32 -04:00
..
_ext Added copy-to-clipboard support for all code snippets 2016-07-06 17:11:59 +02:00
_theme
faq
howto Fixed broken links in docs and comments. 2016-06-15 21:20:23 -04:00
internals Refs #17209 -- Added LoginView and LogoutView class-based views 2016-06-24 10:45:13 +02:00
intro Fixed capitalization of "URL pattern". 2016-07-06 15:31:12 -04:00
man
misc
ref Fixed #26796 -- Added a system check for m2m fields with ignored limit_choices_to. 2016-07-08 19:37:40 -04:00
releases Linked "Features removed" release notes to corresponding deprecation notes. 2016-07-11 15:22:32 -04:00
topics Fixed capitalization of "URL pattern". 2016-07-06 15:31:12 -04:00
conf.py Ignored new warnings when building the docs with Sphinx 1.4. 2016-06-01 11:03:41 -04:00
contents.txt
glossary.txt
index.txt Fixed #26709 -- Added class-based indexes. 2016-06-27 10:41:01 -04:00
make.bat
Makefile
README
spelling_wordlist Refs #26666 -- Added ALLOWED_HOSTS validation when running tests. 2016-06-20 11:07:46 -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/