mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-18 07:26:04 +00:00
Code Issues 24 Releases Wiki Activity
250e2b422b
django/docs
History
Tim Graham 250e2b422b Silenced some GIS deprecation warnings; refs #22384.
2014-06-07 19:35:57 -04:00
..
_ext Removed duplicate "Deprecated in Django A.B" text in docs. 2014-06-06 20:31:23 -04:00
_theme Removed duplicate "Deprecated in Django A.B" text in docs. 2014-06-06 20:31:23 -04:00
faq Fixed #3711, #6734, #12581 -- Bounded connection.queries. 2014-06-07 14:37:43 +02:00
howto Fixed #22619 -- Corrected description of os.path. 2014-05-12 18:56:34 -04:00
internals Added a patch review checklist. 2014-06-03 11:55:17 -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 Added formatting and line wrapping to checks reference doc. 2014-06-06 15:19:20 -04:00
releases Silenced some GIS deprecation warnings; refs #22384. 2014-06-07 19:35:57 -04:00
topics Merge pull request #2764 from gchp/ticket-20550 2014-06-06 14:05:41 +02:00
conf.py Fixed #17238 -- Added source code links to docs using sphinx.ext.viewcode. 2014-06-07 08:54:54 -04:00
contents.txt
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
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
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/