django

mirror of https://github.com/django/django.git synced 2024-12-25 10:35:48 +00:00

History

Mariusz Felisiak 9a0e5052ed Corrected exception types in QuerySet docs.		2020-09-13 20:09:44 +02: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	Removed reference to unsupported versions of Django and Python.	2020-06-03 21:28:14 +02:00
howto	Fixed #31912 -- Removed strict=True in Path.resolve() in project template and CommonPasswordValidator.	2020-08-28 05:57:36 +02:00
internals	Fixed #31877 -- Reverted "Fixed #19878 -- Deprecated TemplateView passing URL kwargs into context."	2020-08-24 11:37:59 +02:00
intro	Updated How to install Django on Windows guide.	2020-06-03 16:28:10 +02:00
man
misc
ref	Corrected exception types in QuerySet docs.	2020-09-13 20:09:44 +02:00
releases	Refs #31956 -- Doc'd consequences of disabling psycopg2's JSONB typecaster.	2020-09-10 11:00:13 +02:00
topics	Fixed #31894 -- Added note about using JSONField key lookups with QuerySet.exclude() in docs.	2020-09-04 09:04:38 +02:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
spelling_wordlist	Fixed #31928 -- Fixed detecting an async get_response in various middlewares.	2020-08-28 12:33:15 +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/