django

mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00

History

Simon Charette aec71aaa5b Fixed #33304 -- Allowed passing string expressions to Window(order_by).		2021-11-23 07:58:44 +01:00
..
_ext	Fixed crash building HTML docs since Sphinx 4.3.	2021-11-17 12:31:25 +01:00
_theme
faq
howto	Used :source: role in docs/howto/custom-template-tags.txt.	2021-10-14 06:04:56 +02:00
internals	Corrected isort example in coding style docs.	2021-11-22 12:34:32 +01:00
intro	Corrected module reference in contributing tutorial.	2021-11-03 07:47:27 +01:00
man
misc
ref	Fixed #33304 -- Allowed passing string expressions to Window(order_by).	2021-11-23 07:58:44 +01:00
releases	Fixed #33304 -- Allowed passing string expressions to Window(order_by).	2021-11-23 07:58:44 +01:00
topics	Fixed #33163 -- Added example of connection signal handlers in AppConfig.ready() to docs.	2021-11-17 09:55:51 +01:00
conf.py	Refs #33247 -- Used XeLaTeX for PDF docs build.	2021-11-12 09:36:18 +01:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt	Refs #33247 -- Corrected configuration for Read The Docs.	2021-11-03 18:35:27 +01:00
spelling_wordlist	Added 'formatter' to spelling wordlist.	2021-10-12 15:16:00 +02: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/