django

mirror of https://github.com/django/django.git synced 2024-11-19 16:04:13 +00:00

History

Ramon Moraes 3b759661a8 Updated xhtml2pdf name/URL in docs.		2016-02-02 07:36:38 -05:00
..
_ext	Fixed #23868 -- Added support for non-unique django-admin-options in docs.	2016-01-14 18:21:33 -05:00
_theme	Fixed many spelling mistakes in code, comments, and docs.	2015-12-03 12:48:24 -05:00
faq	Fixed #26020 -- Normalized header stylings in docs.	2016-01-22 12:12:17 -05:00
howto	Updated xhtml2pdf name/URL in docs.	2016-02-02 07:36:38 -05:00
internals	Idan -> core alumni	2016-01-28 11:25:56 +02:00
intro	Clarified "same as above" tutorial comment.	2016-02-01 16:37:59 -05:00
man	Discouraged use of /tmp with predictable names.	2015-12-24 09:54:33 -05:00
misc	Fixed #26020 -- Normalized header stylings in docs.	2016-01-22 12:12:17 -05:00
ref	Unified some doc links to OneToOneField and ManyToManyField.	2016-02-01 11:02:26 -05:00
releases	Fixed #26155 -- Skipped URL checks if no ROOTURL_CONF setting.	2016-02-01 13:51:38 -05:00
topics	Fixed #26152 -- Documented how to avoid django.setup() deadlock in standalone scripts.	2016-02-01 13:40:53 -05:00
conf.py	Fixed #23868 -- Added support for non-unique django-admin-options in docs.	2016-01-14 18:21:33 -05:00
contents.txt	Fixed #26020 -- Normalized header stylings in docs.	2016-01-22 12:12:17 -05:00
glossary.txt	Fixed #26020 -- Normalized header stylings in docs.	2016-01-22 12:12:17 -05:00
index.txt	Fixed #26020 -- Normalized header stylings in docs.	2016-01-22 12:12:17 -05:00
make.bat
Makefile
README
spelling_wordlist	Fixed #24109 -- Allowed RunSQL and RunPython operations to be elided.	2016-01-23 14:19:03 -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/