mirrors
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues 24 Releases Wiki Activity
django/docs
History
Alex Gaynor 831f2846dd Fixed #18819 -- fixed some typos in the auth docs 2012-08-20 14:27:28 -07:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs
…
faq Moved a note about django-admin.py errors from Tutorial Part 1 to a new FAQ Troubleshooting page. This is to avoid confusion for beginners. 2012-08-04 17:27:57 -07:00
howto [py3] Ported django.utils.safestring. 2012-08-18 16:04:06 +02:00
internals Removed missplaced label in the docs. 2012-08-12 12:43:05 +02:00
intro Added a warning about the {% url %} syntax change 2012-08-18 09:58:42 +02: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 Tweaked SpatiaLite GeoDjango docs. 2012-08-19 22:03:50 -03:00
releases Fixed #18023 -- Documented simplejson issues. 2012-08-20 21:21:00 +02:00
topics Fixed #18819 -- fixed some typos in the auth docs 2012-08-20 14:27:28 -07: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
conf.py Fixed #18698 -- Configure latex to support '≥' in the docs. 2012-08-11 21:48:11 +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 #18799 -- Improved index links for CBV documentation. 2012-08-20 13:46:36 +10:00
make.bat Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +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/