1
0
mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00
django/docs
Tim Graham 23d9f517dc Fixed #21585 -- Updated some links to 3rd party database projects.
Thanks graeme.perrow at sap.com for the original report.
2013-12-18 18:48:21 -05:00
..
_ext Fixed E127 pep8 warnings. 2013-12-14 11:59:15 -05:00
_theme/djangodocs Fixed #21558 -- Support building CHM files. 2013-12-04 16:46:56 +01:00
faq Updated a bunch of hyperlinks in documentation 2013-12-08 18:40:09 +01:00
howto Updated a bunch of hyperlinks in documentation 2013-12-08 18:40:09 +01:00
internals Fixed #11629 -- Deprecated callable arguments to queryset methods. 2013-12-18 18:40:00 +01:00
intro Fixed #21613 -- Removed a hardcoded input id from the tutorial. 2013-12-18 18:36:01 -05:00
man Enabled makemessages to support several translation directories 2013-11-30 11:00:23 +01:00
misc Whitespace cleanup. 2013-10-10 16:49:20 -04:00
ref Fixed #21585 -- Updated some links to 3rd party database projects. 2013-12-18 18:48:21 -05:00
releases Fixed #21386 -- Removed admindocs dependence on sites framework 2013-12-18 19:44:04 +01:00
topics Fixed #21585 -- Updated some links to 3rd party database projects. 2013-12-18 18:48:21 -05:00
conf.py Fixed all E261 warnings 2013-11-02 18:20:39 -04:00
contents.txt
glossary.txt
index.txt Updated a bunch of hyperlinks in documentation 2013-12-08 18:40:09 +01:00
make.bat
Makefile
README Whitespace cleanup. 2013-10-10 16:49:20 -04: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/