1
0
mirror of https://github.com/django/django.git synced 2024-11-19 07:54:07 +00:00
django/docs
2015-05-12 19:42:42 -04:00
..
_ext Fixed E265 comment style 2015-02-06 09:30:35 -05:00
_theme
faq Removed Django 1.6 from the Python version chart. 2015-04-02 14:21:01 -04:00
howto Fixed typo in docs/howto/deployment/wsgi/apache-auth.txt 2015-04-13 07:50:23 -04:00
internals Fixed #24733 -- Passed the triggering exception to 40x error handlers 2015-05-11 22:02:14 +02:00
intro Added link to the code of conduct from contributing guides. 2015-04-17 18:12:41 -04:00
man Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
misc
ref Fixed #24733 -- Passed the triggering exception to 40x error handlers 2015-05-11 22:02:14 +02:00
releases [1.8.x] Refs #24698, #24712 -- Forwardported ForeignKey.get_db_prep_value() test and release notes. 2015-05-12 19:42:42 -04:00
topics Light edits to docs/topics/forms/index.txt 2015-05-12 09:16:13 -04:00
conf.py Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
contents.txt
glossary.txt
index.txt Fixed #23814 -- Documented apps refactored out of Django. 2015-03-25 08:46:23 -04:00
make.bat
Makefile
README
spelling_wordlist Updated capitalization in the word "JavaScript" for consistency 2015-05-01 13:26:42 -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/