1
0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
django/docs
2021-03-19 08:04:37 +01:00
..
_ext
_theme
faq Added stub release notes for 4.0. 2021-01-14 17:50:04 +01:00
howto Updated links to DEPs. 2021-02-25 17:22:07 +01:00
internals Updated link to Selenium webdrivers. 2021-03-09 11:29:54 +01: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 Fixed #16010 -- Added Origin header checking to CSRF middleware. 2021-03-18 20:25:20 +01:00
releases Refs #32508 -- Raised Type/ValueError instead of using "assert" in django.core. 2021-03-19 08:04:37 +01:00
topics Refs #25735 -- Added tags/exclude_tags arguments to DiscoverRunner docs. 2021-03-19 08:03:57 +01: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 #32018 -- Extracted admin colors into CSS variables. 2021-01-07 10:07:19 +01: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/