0
0
mirror of https://github.com/django/django.git synced 2024-11-25 07:59:34 +01:00
django/docs
2024-03-18 16:11:38 +01:00
..
_ext Applied Black's 2024 stable style. 2024-01-26 12:45:07 +01:00
_theme
faq
howto Fixed typos in docstrings and docs. 2024-03-07 06:01:01 +01:00
internals Fixed #14831 -- Extended template style guide in docs. 2024-03-11 11:05:54 +01:00
intro Removed distracting note from tutorial 4. 2024-02-21 06:21:20 +01:00
man
misc Removed mention of designers in DTL design philosophy. 2024-02-01 09:20:11 +01:00
ref Refs #34059, Refs #34060 -- Removed outdated warning about validation of JSONField constraints. 2024-03-18 16:11:38 +01:00
releases Refs #31014 -- Added srid argument to FromWKB/FromWKT() GIS functions. 2024-03-18 09:45:33 +01:00
topics Fixed #34901 -- Added async-compatible interface to session engines. 2024-03-13 17:55:15 +01:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist Fixed #24018 -- Allowed setting pragma options on SQLite. 2024-02-16 12:59:19 +01: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/