1
0
mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00
django/docs
Baptiste Mispelon e6e664a711 Fixed #33302 -- Made element_id optional argument for json_script template filter.
Added versionchanged note in documentation
2021-11-22 11:52:19 +01:00
..
_ext Fixed crash building HTML docs since Sphinx 4.3. 2021-11-17 12:31:25 +01:00
_theme
faq Refs #32074 -- Doc'd Python 3.10 compatibility in Django 3.2.x. 2021-10-05 13:30:41 +02:00
howto Used :source: role in docs/howto/custom-template-tags.txt. 2021-10-14 06:04:56 +02:00
internals Corrected "pip install" call in coding style docs. 2021-11-22 09:56:56 +01:00
intro Corrected module reference in contributing tutorial. 2021-11-03 07:47:27 +01:00
man Updated man page for Django 4.0 alpha. 2021-09-20 20:55:10 +02:00
misc Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
ref Fixed #33302 -- Made element_id optional argument for json_script template filter. 2021-11-22 11:52:19 +01:00
releases Fixed #33302 -- Made element_id optional argument for json_script template filter. 2021-11-22 11:52:19 +01:00
topics Fixed #33163 -- Added example of connection signal handlers in AppConfig.ready() to docs. 2021-11-17 09:55:51 +01:00
conf.py Refs #33247 -- Used XeLaTeX for PDF docs build. 2021-11-12 09:36:18 +01:00
contents.txt
glossary.txt
index.txt Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
make.bat
Makefile
README.rst
requirements.txt Refs #33247 -- Corrected configuration for Read The Docs. 2021-11-03 18:35:27 +01:00
spelling_wordlist Added 'formatter' to spelling wordlist. 2021-10-12 15:16:00 +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/