0
0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
django/docs
2021-04-06 12:44:40 +02:00
..
_ext
_theme Fixed #16300 -- Improved singlehtml docs formatting with headers CSS. 2020-06-22 21:05:13 +02:00
faq Added stub release notes for 4.0. 2021-01-14 17:50:04 +01:00
howto Refs #32105 -- Moved ExceptionReporter template paths to properties. 2021-03-31 08:41:57 +02:00
internals Updated asgiref dependency for 3.2 release series. 2021-04-06 10:38:43 +02:00
intro Updated Git branch "master" to "main". 2021-03-09 08:48:32 +01:00
man Updated django-admin man page for Django 3.2. 2021-01-14 14:58:28 +01:00
misc
ref Refs #30156 -- Corrected version in SpatiaLite install instructions. 2021-04-06 12:44:40 +02:00
releases Added stub release notes for Django 3.2.1. 2021-04-06 11:49:48 +02:00
topics Fixed #32594 -- Doc'd and tested that Signal.disconnect() with lazy references returns None. 2021-04-03 14:57:43 +02:00
conf.py Updated Git branch "master" to "main". 2021-03-09 08:48:32 +01:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt Used GitHub actions for docs tests. 2021-02-26 22:12:25 +01:00
spelling_wordlist Fixed #31840 -- Added support for Cross-Origin Opener Policy header. 2021-03-30 19:59:24 +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), 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/