django/docs
Jon Dufresne c74378bb77 Fixed #27299 -- Documented the Widget.use_required_attribute() method.
Thanks Tim Graham for the review and edits.
2016-10-26 19:29:16 -07:00
..
_ext Added a CVE role for Sphinx. 2016-09-26 15:48:40 -04:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq Updated postgresql.org links to https and made them canonical. 2016-10-25 11:43:32 -04:00
howto Replaced Outputting PDF's "Further Resources" with a link to Django Packages. 2016-10-25 11:58:19 -04:00
internals Fixed #26357 -- Allowed admin popups to work on links added after page load. 2016-10-24 20:17:31 -04:00
intro Fixed #27174 -- Explained where PollsConfig comes from in tutorial 2. 2016-09-07 14:12:53 -04:00
man Discouraged use of /tmp with predictable names. 2015-12-24 09:54:33 -05:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref Fixed #27299 -- Documented the Widget.use_required_attribute() method. 2016-10-26 19:29:16 -07:00
releases Fixed #27299 -- Documented the Widget.use_required_attribute() method. 2016-10-26 19:29:16 -07:00
topics Reverted "Fixed #26401 -- Added BaseAuthConfig to use auth without migrations." 2016-10-25 17:32:59 -07:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Added a CVE role for Sphinx. 2016-09-26 15:48:40 -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 #26709 -- Added class-based indexes. 2016-06-27 10:41:01 -04:00
make.bat
spelling_wordlist Fixed #27352 -- Doc'd social media fingerprinting consideration with login's redirect_authenticated_user. 2016-10-18 11:37:56 -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/