django/docs
GappleBee 218f69f05e Fixed #28041 -- Added Lexeme expression to contrib.postgres.search.
This expression automatically escapes its input and allows
fine-grained control over prefix matching and term weighting
via logical combinations.

Thanks Mariusz Felisiak, Adam Zapletal, Paolo Melchiorre,
Jacob Walls, Adam Johnson, and Simon Charette for reviews.

Co-authored-by: joetsoi <joetsoi@users.noreply.github.com>
Co-authored-by: Karl Hobley <karl@kaed.uk>
Co-authored-by: Alexandr Tatarinov <tatarinov1997@gmail.com>
2025-09-16 15:09:11 -04:00
..
_ext Fixed typo in source file linking Sphinx extension. 2024-07-01 11:32:48 -03:00
_theme
faq Refs #36485 -- Rewrapped docs to 79 columns line length. 2025-08-25 10:51:10 -03:00
howto Ensured :doc: role uses absolute targets in docs. 2025-08-28 13:48:32 -03:00
internals Refs #35667 -- Corrected usage of skip_file_prefixes in contributing docs. 2025-09-13 08:20:17 -04:00
intro Fixed #36564 -- Changed DEFAULT_AUTO_FIELD from AutoField to BigAutoField. 2025-09-05 10:43:10 -04:00
man Americanized some spellings. 2025-04-16 10:21:38 +02:00
misc Refs #36485 -- Rewrapped docs to 79 columns line length. 2025-08-25 10:51:10 -03:00
ref Fixed #28041 -- Added Lexeme expression to contrib.postgres.search. 2025-09-16 15:09:11 -04:00
releases Fixed #28041 -- Added Lexeme expression to contrib.postgres.search. 2025-09-16 15:09:11 -04:00
topics Fixed #36591 -- Removed unnecessary dotted paths in email docs. 2025-09-15 11:46:35 +02:00
conf.py Refs #36500 -- Rewrapped long docstrings and block comments via a script. 2025-07-23 20:17:55 -03:00
contents.txt Ensured :doc: role uses absolute targets in docs. 2025-08-28 13:48:32 -03:00
glossary.txt Refs #36485 -- Rewrapped docs to 79 columns line length. 2025-08-25 10:51:10 -03:00
index.txt Ensured :doc: role uses absolute targets in docs. 2025-08-28 13:48:32 -03:00
lint.py Refs #36485 -- Corrected docs linter to detect too-long lines at file end. 2025-08-29 17:35:50 -04:00
make.bat Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions. 2025-08-25 10:51:10 -03:00
Makefile Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions. 2025-08-25 10:51:10 -03:00
README.rst
requirements.txt Refs #36485 -- Added sphinx-lint support and make lint rule for docs. 2025-08-25 10:51:10 -03:00
spelling_wordlist Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions. 2025-08-25 10:51:10 -03: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/