1
0
mirror of https://github.com/django/django.git synced 2025-01-03 06:55:47 +00:00
django/docs
2020-02-27 10:53:29 +01:00
..
_ext
_theme
faq
howto Simplified imports from django.db and django.contrib.gis.db. 2020-02-04 13:20:06 +01:00
internals Refs #26601 -- Deprecated passing None as get_response arg to middleware classes. 2020-02-18 20:03:44 +01:00
intro Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
man
misc
ref Fixed #31185 -- Fixed detecting of unique fields in ForeignKey/ForeignObject checks when using Meta.constraints. 2020-02-27 10:53:29 +01:00
releases Fixed #31312 -- Properly ordered temporal subtraction params on MySQL. 2020-02-27 08:50:55 +01:00
topics Fixed #31303 -- Removed outdated note about symmetrical intermediate table for self-referential ManyToManyField. 2020-02-24 08:26:29 +01:00
conf.py Fixed #28290 -- Enabled Sphinx auto-label generation for title and section headers. 2020-01-29 14:34:14 +01:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
spelling_wordlist

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/