0
0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
django/docs
2016-09-28 06:50:49 -04:00
..
_ext Added a CVE role for Sphinx. 2016-09-26 15:48:40 -04:00
_theme
faq Added Django 1.11, 2.0 to Python version support table. 2016-08-26 17:21:46 -04:00
howto Fixed #27212 -- Fixed typo in docs/howto/static-files/index.txt. 2016-09-12 16:05:27 -04:00
internals Doc'd how to use GitHub's "Squash and merge" button. 2016-09-21 12:13:21 -04:00
intro Fixed #27174 -- Explained where PollsConfig comes from in tutorial 2. 2016-09-07 14:12:53 -04:00
man
misc
ref Fixed #27076 -- Documented contrib.admin.sites.AdminSite.register(). 2016-09-27 12:16:44 -04:00
releases Fixed 27283 -- Fixed typo in 1.8 release notes. 2016-09-28 06:50:49 -04:00
topics Fixed #20705 -- Allowed using PasswordResetForm with user models with an email field not named 'email'. 2016-09-27 11:59:00 -04:00
conf.py Added a CVE role for Sphinx. 2016-09-26 15:48:40 -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 Added myself to ops team (#7273) 2016-09-21 09:42:00 +02:00

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/