django/docs
Mar Sánchez f1d4a540b2 Refs #15396 -- Mentioned full path to GZipMiddleware in documentation. 2019-10-02 14:39:01 +02: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 Added stub release notes for 3.1. 2019-09-10 12:00:56 +02:00
howto Removed versionadded/changed annotations for 2.2. 2019-09-10 12:01:00 +02:00
internals Refs #30010 -- Doc'd running tests with django-docker-box. 2019-10-02 13:43:47 +02:00
intro Fixed #30775 -- Added admonition about missing imports to "Running tests" section in tutorial 5. 2019-09-16 09:40:44 +02:00
man Updated man page for 3.0 alpha release. 2019-09-10 10:10:50 +02:00
misc Updated various links in docs to avoid redirects 2017-05-22 19:28:44 +02:00
ref Refs #15396 -- Mentioned full path to GZipMiddleware in documentation. 2019-10-02 14:39:01 +02:00
releases Fixed #30821 -- Added ExtractIsoWeekYear database function and iso_week_day lookup. 2019-10-02 10:41:34 +02:00
topics Fixed #30597 -- Clarified how to unapply migrations. 2019-09-27 21:25:27 +02: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 Bumped version; master is now 3.1 pre-alpha. 2019-09-10 11:54:25 +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/