django/docs
Mike Edmunds 6320915053
Some checks failed
Linters / flake8 (push) Waiting to run
Linters / isort (push) Waiting to run
Linters / black (push) Waiting to run
Tests / Windows, SQLite, Python 3.13 (push) Waiting to run
Tests / JavaScript tests (push) Waiting to run
Docs / docs (push) Has been cancelled
Docs / blacken-docs (push) Has been cancelled
Refs #36163 -- Reordered EmailMessage options in docs/topics/email.txt.
Reordered the keyword-only EmailMessage parameters in the documentation
to group similar options together and move rarely used options later.

Used keywords for *all* parameters in EmailMessage examples to improve
clarity.
2025-07-17 14:01:16 -03:00
..
_ext Fixed typo in source file linking Sphinx extension. 2024-07-01 11:32:48 -03:00
_theme
faq Added Django ecosystem page to the documentation. 2025-07-13 14:09:47 +02:00
howto Fixed #35680 -- Added automatic imports of common utilies to shell management command. 2025-07-17 12:51:43 +02:00
internals Fixed #36163 -- Deprecated most positional arguments in django.core.mail. 2025-07-17 14:01:16 -03:00
intro Added Django ecosystem page to the documentation. 2025-07-13 14:09:47 +02:00
man Americanized some spellings. 2025-04-16 10:21:38 +02:00
misc Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:14:27 +01:00
ref Fixed #35680 -- Added automatic imports of common utilies to shell management command. 2025-07-17 12:51:43 +02:00
releases Fixed #36163 -- Deprecated most positional arguments in django.core.mail. 2025-07-17 14:01:16 -03:00
topics Refs #36163 -- Reordered EmailMessage options in docs/topics/email.txt. 2025-07-17 14:01:16 -03:00
conf.py Fixed #36320 -- Ignored "duplicated_toc_entry" for ePub docs build. 2025-04-12 19:39:07 +02:00
contents.txt
glossary.txt
index.txt Fixed #15727 -- Added Content Security Policy (CSP) support. 2025-06-27 15:57:02 -03:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
Makefile Fixed #36162 -- Fixed the black Makefile docs rule to work on macOS. 2025-02-01 22:27:38 -03: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 #15727 -- Added Content Security Policy (CSP) support. 2025-06-27 15:57:02 -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/