1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
django/docs
2023-06-11 15:01:06 +02:00
..
_ext Removed unnecessary workarounds for Sphinx < 4.3.0. 2023-05-04 13:55:06 +02:00
_theme
faq Fixed #34545 -- Corrected the number of months in installation FAQ. 2023-05-08 08:34:23 +02:00
howto Updated broken links in docs. 2023-05-17 12:13:10 +02:00
internals Fixed #34609 -- Deprecated calling format_html() without arguments. 2023-06-06 14:14:57 +02:00
intro Fixed #34621 -- Made admin site header render in <div> tag. 2023-06-05 11:55:06 +02:00
man Updated man page for Django 4.2 alpha. 2023-01-17 08:51:17 +01:00
misc
ref Fixed #23049 -- Added %a and %A support to Date.strftime. 2023-06-09 12:18:17 +02:00
releases Fixed #34638 -- Fixed admin change list selected row highlight on editable boolean fields. 2023-06-11 15:01:06 +02:00
topics Fixed #30355 -- Doc'd interaction between custom managers and prefetch_related(). 2023-06-07 11:48:01 +02:00
conf.py Used extlinks for PyPI links. 2023-04-17 06:55:32 +02:00
contents.txt
glossary.txt
index.txt Added Django Forum to mailing lists page. 2023-03-24 08:32:17 +01:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
Makefile Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
README.rst
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Fixed #34574 -- Noted unexpected outcomes in autoescape/escape docs. 2023-05-26 06:21:46 +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/