django

mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00

History

Michal Petrucha fe8ea3ba3b Fixed #26217 -- Added a warning about format strings to WeekArchiveView docs.		2016-03-01 10:29:52 -05:00
..
_ext
_theme
faq
howto	Fixed #26243 -- Noted that 'python -R' is enabled by default in Python 3.3.	2016-02-19 10:50:15 -05:00
internals	Minor fixes for release-process doc fix	2016-02-28 19:30:18 +02:00
intro	Fixed #26221 -- Used find_packages() in reusable apps tutorial.	2016-02-15 19:25:26 -05:00
man
misc
ref	Fixed #26217 -- Added a warning about format strings to WeekArchiveView docs.	2016-03-01 10:29:52 -05:00
releases	Fixed #26186 -- Documented how app relative relationships of abstract models behave.	2016-02-29 22:07:05 -05:00
topics	Corrected a run on sentence in doc/topics/db/models.txt.	2016-02-25 14:22:41 -05:00
conf.py	Fixed possible "RuntimeError: maximum recursion depth exceeded" building docs.	2016-02-16 07:30:32 -05:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist	Added 'prefetches to docs/spelling_wordlist.	2016-02-26 16:06:34 -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/