0
0
mirror of https://github.com/django/django.git synced 2024-11-30 15:10:46 +01:00
django/docs
2019-11-06 08:24:49 +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 Made minor edits and small fixes to docs/faq/install.txt. 2019-10-04 11:21:50 +02:00
howto Fixed #30906 -- Fixed an example of using the template system to generate CSV. 2019-10-25 08:11:11 +02:00
internals Fixed #30927 -- Simplified an example of test for the deprecation warning with assertWarnsMessage(). 2019-10-30 13:35:36 +01:00
intro Fixed #30944 -- Changed reusable apps docs to use a declarative config. 2019-11-05 14:58:09 +01:00
man Updated man page for 3.0 alpha release. 2019-09-10 10:10:50 +02:00
misc
ref Added a link to the file email backend from EMAIL_FILE_PATH setting. 2019-11-06 08:24:49 +01:00
releases Fixed #30947 -- Changed tuples to lists in model Meta options in django.contrib modules. 2019-11-05 08:16:31 +01:00
topics Refs #30947 -- Changed tuples to lists in model Meta options examples in docs. 2019-11-04 10:20:30 -08:00
conf.py Bumped version; master is now 3.1 pre-alpha. 2019-09-10 11:54:25 +02:00
contents.txt
glossary.txt
index.txt Fixed #30767 -- Improved references to deployment documentation. 2019-09-09 10:02:33 +02:00
make.bat
Makefile
README Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02:00
spelling_wordlist Fixed #27910 -- Added enumeration helpers for use in Field.choices. 2019-09-04 14:42:49 +02: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 ``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/