django

mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00

History

Éric Araujo cbffc900bb Fix link target markup This markup for a code block is redundant with the code-block directive below, and blocks the following line from working as link target.		2014-11-17 16:37:18 -07:00
..
_ext
_theme
faq	Fixed #23527 -- Removed Cheetah references in docs	2014-09-21 18:03:31 +02:00
howto	Fixed #20435 -- Reordered the custom template tags docs.	2014-11-17 17:38:04 +01:00
internals	Removed support for function-based template loaders.	2014-11-16 22:18:33 +01:00
intro	Fixed #23855 -- Removed unnecessary all() in tutorial 3.	2014-11-17 18:10:50 +01:00
man
misc
ref	Moved all template loaders under django.template.loaders.	2014-11-16 21:28:26 +01:00
releases	Fixed #23859 -- Fixed a migration crash when a field is renamed that is part of an index_together	2014-11-17 19:15:07 +01:00
topics	Fix link target markup	2014-11-17 16:37:18 -07:00
conf.py	Removed simplejson inventory file from docs/conf.py.	2014-10-25 07:31:12 +03:00
contents.txt
glossary.txt	Fixed some intersphinx references.	2014-10-16 20:00:17 -04:00
index.txt	Fixed #14030 -- Allowed annotations to accept all expressions	2014-11-15 14:00:43 +00:00
make.bat
Makefile
README	Removed sudo from pip commands in docs.	2014-09-22 15:49:48 -04:00
spelling_wordlist	Fixed spelling errors in docs.	2014-11-11 16:41:09 +01: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 ``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/