1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
2014-12-18 11:55:33 -05:00
..
_ext Fixed #23968 -- Replaced list comprehension with generators and dict comprehension 2014-12-08 07:58:23 -05:00
_theme
faq Removed need to update Python version support note on each new release. 2014-12-18 11:55:33 -05:00
howto Fixed typo in docs/howto/custom-lookups.txt. 2014-12-08 07:18:54 -05:00
internals Fixed #23884 -- Moved FlatPageSitemap into django.contrib.flatpages. 2014-12-15 09:45:31 -05:00
intro Removed redundant numbered parameters from str.format(). 2014-12-03 14:27:38 -05:00
man Fixed #18714 -- Added 'fuzzy' compilemessages option 2014-11-18 22:44:16 +01:00
misc
ref Updated TemplateResponseMixin docs to reflect new behavior after refs #23789. 2014-12-17 20:02:15 -05:00
releases Fixed #24014 -- Unified OGRException and GDALException 2014-12-18 11:28:17 +01:00
topics Fixed display of lists after website redesign 2014-12-17 08:24:00 -05:00
conf.py Updated formtools docs to point at new package outside the Django repo. 2014-11-26 09:41:52 -05:00
contents.txt
glossary.txt Fixed some intersphinx references. 2014-10-16 20:00:17 -04:00
index.txt Updated formtools docs to point at new package outside the Django repo. 2014-11-26 09:41:52 -05:00
make.bat
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README
spelling_wordlist Appeased spell checker. 2014-12-11 14:43:47 -05: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/