django

mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00

History

Claude Paroz 337cd09836 Updated some other external links in the docs		2014-12-19 18:07:52 +01:00
..
_ext	Fixed #23968 -- Replaced list comprehension with generators and dict comprehension	2014-12-08 07:58:23 -05:00
_theme	Added newlines to the ends of CSS, HTML, and JavaScript files missing them.	2014-08-12 19:22:09 -04:00
faq	Used https for most *.python.org links	2014-12-19 18:07:52 +01:00
howto	Updated some other external links in the docs	2014-12-19 18:07:52 +01:00
internals	Updated some other external links in the docs	2014-12-19 18:07:52 +01:00
intro	Used https for most *.python.org links	2014-12-19 18:07:52 +01:00
man	Fixed #18714 -- Added 'fuzzy' compilemessages option	2014-11-18 22:44:16 +01:00
misc	Fixed #16785 -- Documented some of the design decisions of the cache framework.	2014-01-16 21:13:08 -05:00
ref	Updated some other external links in the docs	2014-12-19 18:07:52 +01:00
releases	Updated some other external links in the docs	2014-12-19 18:07:52 +01:00
topics	Updated some other external links in the docs	2014-12-19 18:07:52 +01:00
conf.py	Used https for most *.python.org links	2014-12-19 18:07:52 +01:00
contents.txt
glossary.txt	Fixed some intersphinx references.	2014-10-16 20:00:17 -04:00
index.txt	Updated formtools docs to point at new package outside the Django repo.	2014-11-26 09:41:52 -05:00
make.bat
Makefile	Added an "htmlview" target to open docs after building them.	2014-12-08 07:23:34 -05:00
README	Removed sudo from pip commands in docs.	2014-09-22 15:49:48 -04:00
spelling_wordlist	Appeased spell checker.	2014-12-11 14:43:47 -05: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/