0
0
mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00
django/docs
2015-11-02 20:09:21 +01:00
..
_ext Removed obsolete literals_to_xrefs.py script. 2015-06-15 10:22:18 -04:00
_theme Added white-space: pre-wrap; to docs code blocks to match docs.dp.com. 2015-06-22 15:56:06 -04:00
faq Added Django 1.10 to Python version support table. 2015-10-26 10:28:53 -04:00
howto Revised Windows install instructions for Python 3.5. 2015-10-21 20:25:57 -04:00
internals Fixed #25550 -- Deprecated direct assignment to the reverse side of a related set. 2015-10-27 07:57:15 -04:00
intro Optimized docs images and documented the process. 2015-10-24 14:57:21 -04:00
man Fixed #25578 -- Corrected the casing of "GitHub". 2015-10-21 07:31:11 -04:00
misc Updated release process for new release schedule. 2015-06-25 11:36:17 -04:00
ref Refs #25629 -- Added arity class attribute to Func expressions 2015-11-02 20:09:21 +01:00
releases Refs #25629 -- Added arity class attribute to Func expressions 2015-11-02 20:09:21 +01:00
topics Fixed typo in docs/topics/db/models.txt. 2015-10-31 08:53:00 -04:00
conf.py Bumped version; master is now 1.10 pre-alpha. 2015-09-23 19:31:08 -04:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
index.txt Fixed #24961 -- Added links to all auth docs pages from index. 2015-06-09 12:41:39 -04:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
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 Added "subpath" to spelling wordlist. 2015-10-22 15:01:33 -04:00

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/