django

mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00

History

Tibor Leupold 33f4de34e6 Fixed #34064 -- Adjusted locale override wording in settings docs.		2022-11-24 14:23:20 +01:00
..
_ext
_theme	Fixed docs build with sphinxcontrib-spelling 7.5.0+.	2022-05-31 11:17:01 +02:00
faq	Refs #33173 -- Doc'd Python 3.11 compatibility in Django 4.1.x.	2022-10-26 20:10:33 +02:00
howto	Fixed #34054 -- Created a new fixtures topic.	2022-11-02 08:08:02 +01:00
internals	Improved "rebase" example for upstream changes in working with Git docs.	2022-10-24 10:04:38 +02:00
intro	Updated UTC uses to datetime.timezone.utc in docs.	2022-10-20 15:52:45 -07:00
man
misc
ref	Fixed #34064 -- Adjusted locale override wording in settings docs.	2022-11-24 14:23:20 +01:00
releases	Fixed #31679 -- Delayed annotating aggregations.	2022-11-23 17:46:07 +01:00
topics	Fixed typo in settings topic doc.	2022-11-23 14:32:58 +01: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	Bumped minimum Sphinx version to 4.5.0 in docs/requirements.txt.	2022-09-26 11:18:15 +02:00
spelling_wordlist	Removed obsolete references to pysqlite.	2022-11-04 08:03:06 +01: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/