django/docs
Mariusz Felisiak 8c85c86922 [2.0.x] Forwardported 1.11.22 release notes. 2019-07-01 10:03:43 +02:00
..
_ext [2.0.x] Replaced CVE/ticket roles with extlinks. 2019-02-01 15:50:43 -05:00
_theme Clarified QuerySet.iterator()'s docs on server-side cursors. 2017-06-01 15:38:30 -04:00
faq [2.0.x] Refs #28814 -- Doc'd Python 3.7 compatibility in Django 1.11.x. 2018-11-17 16:06:11 -05:00
howto [2.0.x] Removed extra characters in docs header underlines. 2019-02-08 21:42:49 +01:00
internals [2.0.x] Used extlinks for GitHub commits. 2019-02-01 15:50:48 -05:00
intro [2.0.x] Removed extra characters in docs header underlines. 2019-02-08 21:42:49 +01:00
man [2.0.x] Updated man page for Django 2.0 alpha. 2017-09-22 12:26:46 -04:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref [2.0.x] Removed extra characters in docs header underlines. 2019-02-08 21:42:49 +01:00
releases [2.0.x] Forwardported 1.11.22 release notes. 2019-07-01 10:03:43 +02:00
topics [2.0.x] Removed extra characters in docs header underlines. 2019-02-08 21:42:49 +01:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
conf.py [2.0.x] Used extlinks for GitHub commits. 2019-02-01 15:50:48 -05:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt [2.0.x] Fixed #28594 -- Removed Jython docs and specific code 2017-12-23 10:28:29 +01:00
make.bat
spelling_wordlist [2.0.x] Added words to docs/spelling_wordlist for Ubuntu 18.04. 2018-09-17 18:57:39 +02: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/