django/docs
David Foster c598ffd2e1 [3.0.x] Fixed #30828 -- Added how to remove/insert many-to-many relations in bulk to the database optimization docs.
Backport of 6a04e69e68 from master
2019-11-12 13:13:20 +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 [3.0.x] Refs #30948 -- Updated install instructions to use pip instead of setup.py. 2019-11-08 21:16:52 +01:00
howto [3.0.x] Fixed #30906 -- Fixed an example of using the template system to generate CSV. 2019-10-25 08:12:15 +02:00
internals [3.0.x] Doc'd archiving historical branches as git tags. 2019-11-08 12:11:18 +01:00
intro [3.0.x] Fixed #30944 -- Changed reusable apps docs to use a declarative config. 2019-11-05 15:01:42 +01:00
man [3.0.x] Updated man page for Django 3.0 beta. 2019-10-14 11:55:27 +02:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref [3.0.x] Fixed #30252 -- Clarified need to reopen forms.fields.ImageField.image file to access raw image data. 2019-11-11 11:48:48 +01:00
releases [3.0.x] Refs #30183 -- Doc'd dropping support for sqlparse < 0.2.2. 2019-11-06 09:01:48 +01:00
topics [3.0.x] Fixed #30828 -- Added how to remove/insert many-to-many relations in bulk to the database optimization docs. 2019-11-12 13:13:20 +01:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02:00
conf.py [3.0.x] Bumped next Django version in docs config. 2019-09-10 10:34:38 +02: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 Fixed #30767 -- Improved references to deployment documentation. 2019-09-09 10:02:33 +02:00
make.bat
spelling_wordlist Fixed #27910 -- Added enumeration helpers for use in Field.choices. 2019-09-04 14:42:49 +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 ``python -m 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/