django/docs
Tim Graham 6d2ae49f25 Refs #27753 -- Removed django.test.utils.patch_logger() and str_prefix(). 2019-02-05 12:52:07 -05:00
..
_ext Fixed crash building translated docs since Sphinx 1.8. 2018-10-01 20:44:02 -04:00
_theme
faq Added stub release notes for 3.0. 2019-01-17 10:50:25 -05:00
howto Fixed #30116 -- Dropped support for Python 3.5. 2019-01-30 10:19:48 -05:00
internals Refs #27753 -- Deprecated django.utils.http urllib aliases. 2019-02-04 18:53:11 -05:00
intro Fixed #30116 -- Dropped support for Python 3.5. 2019-01-30 10:19:48 -05:00
man Updated man page for Django 2.2 alpha. 2019-01-17 16:25:02 +01:00
misc
ref Fixed #30155 -- Dropped support for PostgreSQL 9.4 and PostGIS 2.1. 2019-02-04 18:07:02 -05:00
releases Refs #27753 -- Removed django.test.utils.patch_logger() and str_prefix(). 2019-02-05 12:52:07 -05:00
topics Used LoginRequiredMixin in "Models and request.user" example. 2019-01-31 18:01:53 -05:00
Makefile
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py Used extlinks for GitHub commits. 2019-02-01 21:42:48 +01:00
contents.txt
glossary.txt
index.txt Removed dead links to botbot.me. 2018-11-10 17:25:10 -05:00
make.bat
spelling_wordlist Removed unused words from docs/spelling_wordlist. 2019-02-02 15:36:20 +01: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 ``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/