mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-20 08:24:58 +00:00
Code Issues 24 Releases Wiki Activity
9cbf7f25ef
django/docs
History
Tim Graham 7ff326928a Improved deprecation plan links in release notes.
2014-05-29 18:58:12 -04:00
..
_ext Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 08:52:43 -05:00
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq Used link label in models FAQ to ease translation 2014-05-22 09:46:34 +02:00
howto Fixed #22619 -- Corrected description of os.path. 2014-05-12 18:56:34 -04:00
internals Updated some docs for the delayed deprecation of legacy table creation; refs #22340. 2014-05-07 09:04:01 -04:00
intro Reordered tutorial 1 so that the database is configured first. 2014-05-05 13:34:46 -04:00
man Completed long overdue sqlinitialdata deprecation. 2014-05-11 23:15:59 -03:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed #22682 -- makemigrations will create MIGRATION_MODULES package 2014-05-30 01:23:09 +03:00
releases Improved deprecation plan links in release notes. 2014-05-29 18:58:12 -04:00
topics Fixed #22601 -- Added a note about model inheritance. 2014-05-27 19:42:16 -04:00
conf.py Fixed several typos in Django 2014-05-28 17:39:14 -07:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Added array field support for PostgreSQL. 2014-05-22 09:53:26 +01:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README Whitespace cleanup. 2013-10-10 16:49:20 -04:00
spelling_wordlist Fixed spelling in docs. 2014-05-27 19:46:48 -04: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 ``sudo 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/