0
0
mirror of https://github.com/django/django.git synced 2024-11-29 06:03:25 +01:00
django/docs
Mariusz Felisiak cb06f5ef8c
Reverted "Fixed #30711 -- Doc'd django.contrib.postgres.fields.hstore.KeyTransform()."
This reverts commit 7faf25d682. The same
can be achieved with F() so there is no need to expose an extra API.
2022-08-31 22:12:30 +02:00
..
_ext
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Added stub release notes for 4.2. 2022-05-17 14:22:06 +02:00
howto Fixed #33842 -- Used :source: role for links to repo files on GitHub. 2022-08-09 14:44:51 +02:00
internals Fixed #33924 -- Deprecated BaseGeometryWidget.map_height/map_width attributes. 2022-08-12 13:26:35 +02:00
intro Refs #30947 -- Changed tuples to lists where appropriate. 2022-08-30 09:57:17 +02:00
man Updated man page for Django 4.1 alpha. 2022-05-17 11:21:08 +02:00
misc
ref Reverted "Fixed #30711 -- Doc'd django.contrib.postgres.fields.hstore.KeyTransform()." 2022-08-31 22:12:30 +02:00
releases Added Central Kurdish (Sorani) language. 2022-08-30 11:56:11 +02:00
topics Fixed #33965 -- Improved file-like object example of ImageField in docs. 2022-08-31 12:33:04 +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 Added Central Kurdish (Sorani) language. 2022-08-30 11:56:11 +02: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/