1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
django/docs
2013-10-09 11:42:27 -04:00
..
_ext Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:24:29 -04:00
_theme/djangodocs Fixed #21702 -- Added different bullet styles for nested lists. 2013-09-23 07:37:09 -04:00
faq Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
howto Fixed #21218 -- Typo on docs/howto/upgrade-version.txt 2013-10-03 20:13:33 -04:00
internals Fixed #21222 - Documented that 'default' and 'other' must be different databases when running tests. 2013-10-09 11:42:27 -04:00
intro Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
ref Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
releases Fixed #21164 -- Added documentation for issue with test users. 2013-10-08 10:32:56 +08:00
topics Fixed grammar/typos in auth customization docs 2013-10-09 16:21:19 +02:00
conf.py Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
contents.txt
glossary.txt
index.txt Fixed #21213 -- Added docs for Django's mailing lists. 2013-10-04 10:00:36 -04:00
make.bat
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
README Fixed #21141 -- Update Sphinx URL 2013-09-22 14:44:09 -03: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 ``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-doc.org/