django1/docs
Mariusz Felisiak 8eda248dc9 [2.2.x] Refs #29926 -- Bumped minimum tblib version to 1.5.0 in test requirements.
Backport of 25903e41fb from master.
2019-11-12 21:49:09 +01:00
..
_ext Fixed crash building translated docs since Sphinx 1.8. 2018-10-01 20:44:02 -04:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq [2.2.x] Refs #30948 -- Updated install instructions to use pip instead of setup.py. 2019-11-08 21:17:38 +01:00
howto [2.2.x] Fixed #30906 -- Fixed an example of using the template system to generate CSV. 2019-10-25 08:12:40 +02:00
internals [2.2.x] Refs #29926 -- Bumped minimum tblib version to 1.5.0 in test requirements. 2019-11-12 21:49:09 +01:00
intro [2.2.x] Fixed #30944 -- Changed reusable apps docs to use a declarative config. 2019-11-05 15:05:37 +01:00
man [2.2.x] Updated man page for Django 2.2. 2019-11-04 08:44:55 +01:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref [2.2.x] Fixed #30252 -- Clarified need to reopen forms.fields.ImageField.image file to access raw image data. 2019-11-11 11:49:26 +01:00
releases [2.2.x] Added stub release notes for 2.2.8 release. 2019-11-12 14:42:34 +01:00
topics [2.2.x] Fixed #30828 -- Added how to remove/insert many-to-many relations in bulk to the database optimization docs. 2019-11-12 13:13: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.2.x] Used extlinks for Django's source code. 2019-03-28 20:39:38 -04: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.2.x] Fixed #30767 -- Improved references to deployment documentation. 2019-09-09 10:06:58 +02:00
make.bat
spelling_wordlist Fixed #28990 -- Added autosummarize parameter to BrinIndex. 2018-08-02 11:26:58 -04: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/