1
0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
django/docs
2017-12-02 10:41:35 -05:00
..
_ext Refs #23968 -- Removed unnecessary lists, generators, and tuple calls. 2017-06-01 19:08:59 -04:00
_theme
faq Fixed #27855 -- Updated docs for Python 3.4 support in Django 2.0. 2017-08-11 11:17:08 -04:00
howto Fixed 'a'/'an' mix-ups in docs. 2017-10-30 21:47:09 -04:00
internals Fixed #28759 -- Promoted the contributing guide in the docs for the django-developers mailing list. 2017-11-01 20:35:31 -04:00
intro Fixed #27857 -- Dropped support for Python 3.4. 2017-09-25 17:11:03 -04:00
man Updated man page for Django 2.0 alpha. 2017-09-22 12:28:56 -04:00
misc
ref Clarified who the AdminEmailHandler emails. 2017-11-21 11:49:15 -05:00
releases Added stub release notes for 2.0.1. 2017-12-02 10:41:35 -05:00
topics Fixed #28853 -- Updated connection.cursor() uses to use a context manager. 2017-11-28 11:28:09 -05:00
conf.py Bumped version; master is now 2.1 pre-alpha. 2017-09-22 12:51:17 -04:00
contents.txt
glossary.txt
index.txt Refs #17453 -- Fixed broken link to #django IRC logs. 2017-07-21 18:09:48 -04:00
make.bat
Makefile
README
spelling_wordlist Removed unused words from docs/spelling_wordlist. 2017-11-24 07:53:40 -05: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/