1
0
mirror of https://github.com/django/django.git synced 2024-11-18 07:26:04 +00:00
django/docs
Julien Phalip 6e70f47d02 Merge pull request #1464 from evildmp/squashing_commits
Clarified misleading wording about squashing commits
2013-08-10 14:48:46 -07:00
..
_ext Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:24:29 -04:00
_theme/djangodocs
faq Fixed #19695 -- Retitle "Form Media" to "Form Assets". 2013-07-08 13:59:54 -04:00
howto Fixed #20852 - Fixed incorrectly generated left quotes in docs. 2013-08-06 07:13:17 -04:00
internals Merge pull request #1464 from evildmp/squashing_commits 2013-08-10 14:48:46 -07:00
intro Fixed #20852 - Fixed incorrectly generated left quotes in docs. 2013-08-06 07:13:17 -04:00
man
misc
ref Fixed #9057 -- Added default_permissions model meta option. 2013-08-09 09:19:52 -04:00
releases Fixed #20828 -- Allowed @permission_required to take a list of permissions 2013-08-10 10:10:18 -04:00
topics Fixed #20828 -- Allowed @permission_required to take a list of permissions 2013-08-10 10:10:18 -04:00
conf.py Master is now pre-1.7. 2013-06-28 08:56:45 -05:00
contents.txt
glossary.txt
index.txt Fixed #20766 -- Deprecated FastCGI support. 2013-07-24 13:41:45 -04:00
make.bat
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -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 ``sudo 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.pocoo.org/