django

mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00

History

Jarosław Wygoda 9e7cb27a5b Refs #26029 -- Doc'd django.core.files.storage.default_storage.		2022-08-10 12:23:13 +02:00
..
_ext
_theme	Fixed docs build with sphinxcontrib-spelling 7.5.0+.	2022-05-31 11:17:01 +02:00
faq
howto	Fixed #33842 -- Used :source: role for links to repo files on GitHub.	2022-08-09 14:44:51 +02:00
internals	Fixed #33842 -- Used :source: role for links to repo files on GitHub.	2022-08-09 14:44:51 +02:00
intro	Fixed #33842 -- Used :source: role for links to repo files on GitHub.	2022-08-09 14:44:51 +02:00
man
misc
ref	Refs #26029 -- Doc'd django.core.files.storage.default_storage.	2022-08-10 12:23:13 +02:00
releases	Fixed #33905 -- Fixed CheckConstraint() validation on range fields.	2022-08-09 20:13:21 +02:00
topics	Refs #33842 -- Added :ttag: role in translations docs.	2022-08-09 14:51:59 +02:00
conf.py	Bumped minimum Sphinx version to 4.5.0.	2022-05-31 15:21:17 +02:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile	Fixed #33753 -- Fixed docs build on Sphinx 5+.	2022-06-01 12:13:15 +02:00
README.rst
requirements.txt
spelling_wordlist	Fixed #33725 -- Made hidden quick filter in admin's navigation sidebar not focusable.	2022-05-21 13:37:53 +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/