django

mirror of https://github.com/django/django.git synced 2024-11-30 07:06:18 +01:00

History

Justin Bronn 72b8f8d73b Updated the GEOS, PostGIS, and PROJ.4 versions in the GeoDjango installation docs.		2012-09-07 13:35:09 -04:00
..
_ext	Made more extensive usage of context managers with open.	2012-05-05 14:06:36 +02:00
_theme/djangodocs
faq	Fixed #18905 - Changed to new url for Djangopeople	2012-09-05 16:20:23 +05:30
howto	[py3] Ported django.utils.safestring.	2012-08-18 16:04:06 +02:00
internals	Fixed #18647 - Removed link to Malcolm's blog which is gone.	2012-08-30 07:44:41 -04:00
intro	remove unused import in decoupling URLs tutorial, closes #18915	2012-09-07 11:49:55 -04:00
man	Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review.	2012-04-08 21:13:32 +00:00
misc	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
obsolete
ref	Updated the GEOS, PostGIS, and PROJ.4 versions in the GeoDjango installation docs.	2012-09-07 13:35:09 -04:00
releases	Fixed minor typo in 1.3 release notes.	2012-09-06 21:00:16 +10:00
topics	[py3] Documented forwards-compatible aliases	2012-09-07 11:57:46 -04:00
conf.py	Added latex preamble for ≤.	2012-08-28 22:45:51 +02:00
contents.txt
glossary.txt	Fixed #18451 -- Vastly improved class based view documentation.	2012-06-11 10:40:23 +02:00
index.txt	Fixed #17378 - Added a flattened index for class-based views.	2012-09-01 09:20:38 -04:00
make.bat	Added gettext target to sphinx makefiles.	2012-04-07 22:35:57 +00:00
Makefile	Added gettext target to sphinx makefiles.	2012-04-07 22:35:57 +00:00
README	Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112 .	2012-03-03 09:11:54 +00:00

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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.pocoo.org/