django/docs
Josh Smeaton 6e195b800a Fixed #35267 -- Clarified time zone topic for PostgreSQL in docs.
The timezone documentation for Postgres mentions the behavior of
time zone conversion, but links to the wrong setting that controls the
behavior.

Postgres will not return datetimes in the time zone set by the
TIME_ZONE setting, but rather the time zone of the database connection,
which is defined by DATABASES.TIME_ZONE setting falling back to UTC.

This corrects the link in the documentation and adds note that there
are two distinct TIME_ZONE settings and the one most are familiar with
is not considered for PostgreSQL time zone conversion.
2024-03-05 11:22:54 +01:00
..
_ext Applied Black's 2024 stable style. 2024-01-26 12:45:07 +01:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Updated examples for 2.0+ release numbering in installation FAQ. 2023-12-15 06:16:02 +01:00
howto Corrected BaseCommand.check() signature in docs. 2024-01-30 11:10:38 +01:00
internals Refs #35234 -- Deprecated CheckConstraint.check in favor of .condition. 2024-03-01 07:15:32 +01:00
intro Removed distracting note from tutorial 4. 2024-02-21 06:21:20 +01:00
man Updated man page for Django 5.0 alpha. 2023-09-18 09:25:34 -03:00
misc Removed mention of designers in DTL design philosophy. 2024-02-01 09:20:11 +01:00
ref Refs #33497 -- Added connection pool support for PostgreSQL. 2024-03-01 09:01:18 +01:00
releases Added stub release notes for 5.0.4. 2024-03-04 10:29:33 +01:00
topics Fixed #35267 -- Clarified time zone topic for PostgreSQL in docs. 2024-03-05 11:22:54 +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 Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py Bumped version; main is now 5.1 pre-alpha. 2023-09-18 22:12:40 +02:00
contents.txt
glossary.txt
index.txt Reorganized the Contributing to Django docs. 2024-01-11 22:25:27 -03:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
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 #24018 -- Allowed setting pragma options on SQLite. 2024-02-16 12:59:19 +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/