django

mirror of https://github.com/django/django.git synced 2025-01-10 18:36:05 +00:00

History

LarryBrid a93ee5112d Fixed #22941 - Added support for domain-only links with chars after the TLD to urlize. It now works with something like google.com/foo/bar		2014-07-02 20:36:53 -04:00
..
_ext
_theme	Made docs CSS for versionchanged/added more similar to docs.djangoproject.com.	2014-06-30 18:38:30 -04:00
faq	Fixed #22880 -- Added FAQ entry about UnicodeDecodeError	2014-06-24 09:02:28 +02:00
howto	Fixed typo in parameter name doc for BaseCommand.check().	2014-06-26 07:23:32 -04:00
internals	Fixed #18108 -- Added instructions for translating documentation.	2014-07-02 13:16:31 -04:00
intro	Included irc link in paragraph to allow for l10n	2014-07-01 21:54:32 +02:00
man
misc
ref	Fixed #22941 - Added support for domain-only links with chars after the TLD to urlize.	2014-07-02 20:36:53 -04:00
releases	Fixed #22941 - Added support for domain-only links with chars after the TLD to urlize.	2014-07-02 20:36:53 -04:00
topics	Clarified that LocMemCache is per-process; refs #7639 .	2014-07-02 10:12:43 -04:00
conf.py	Fixed #17238 -- Added source code links to docs using sphinx.ext.viewcode.	2014-06-07 08:54:54 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist	Fixed #22796 -- Added a more basic explanations of forms.	2014-06-24 14:55:22 -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-doc.org/