django/docs
Claude Paroz 3eb72ad30f [3.2.x] Refs #31003 -- Moved note about return value of QuerySet.bulk_create() to the first paragraph.
Backport of cac9ec73db from main.
2021-03-25 20:35:40 +01:00
..
_ext Made default_role_error use logger. 2020-06-03 11:42:42 +02:00
_theme Fixed #16300 -- Improved singlehtml docs formatting with headers CSS. 2020-06-22 21:05:13 +02:00
faq Refs #31040 -- Doc'd Python 3.9 compatibility. 2020-10-13 08:35:01 +02:00
howto [3.2.x] Updated links to DEPs. 2021-02-25 17:27:32 +01:00
internals [3.2.x] Updated link to Selenium webdrivers. 2021-03-09 11:30:56 +01:00
intro [3.2.x] Updated Git branch "master" to "main". 2021-03-09 09:33:50 +01:00
man Updated django-admin man page for Django 3.2. 2021-01-14 14:58:28 +01:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref [3.2.x] Refs #31003 -- Moved note about return value of QuerySet.bulk_create() to the first paragraph. 2021-03-25 20:35:40 +01:00
releases [3.2.x] Fixed #32560 -- Fixed test runner with --pdb and --buffer on fail/error. 2021-03-17 21:51:27 +01:00
topics [3.2.x] Refs #25735 -- Added tags/exclude_tags arguments to DiscoverRunner docs. 2021-03-19 08:06:45 +01:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py [3.2.x] Updated Git branch "master" to "main". 2021-03-09 09:33:50 +01:00
contents.txt
glossary.txt
index.txt Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
make.bat
spelling_wordlist Fixed #32018 -- Extracted admin colors into CSS variables. 2021-01-07 10:07:19 +01:00

README.rst

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

It uses `ReST`_ (reStructuredText), and the `Sphinx`_ documentation system.
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.

.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/