django/docs
Simon Charette 2d34ebe49a Refs #35967 -- Deprecated BaseDatabaseCreation.create_test_db(serialize).
Given there are no longer any internal usages of serialize=True and it
poses a risk to non-test databases integrity it seems appropriate to
deprecate it.
2025-02-16 08:43:42 +01:00
..
_ext Fixed typo in source file linking Sphinx extension. 2024-07-01 11:32:48 -03:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Fixed #36125 -- Switched docs to use chat.djangoproject.com when referencing the Discord server. 2025-01-22 18:22:50 -03:00
howto Fixed #36158 -- Refactored shell command to improve auto-imported objects reporting. 2025-02-13 16:01:13 +01:00
internals Refs #35967 -- Deprecated BaseDatabaseCreation.create_test_db(serialize). 2025-02-16 08:43:42 +01:00
intro Fixed #36125 -- Switched docs to use chat.djangoproject.com when referencing the Discord server. 2025-01-22 18:22:50 -03:00
man Updated man page for Django 5.2 alpha. 2025-01-15 21:11:20 +01:00
misc Removed mention of designers in DTL design philosophy. 2024-02-01 09:20:11 +01:00
ref Corrected wording in docs/ref/models/constraints.txt. 2025-02-14 15:19:12 +01:00
releases Refs #35967 -- Deprecated BaseDatabaseCreation.create_test_db(serialize). 2025-02-16 08:43:42 +01:00
topics Refs #35967 -- Deprecated BaseDatabaseCreation.create_test_db(serialize). 2025-02-16 08:43:42 +01:00
conf.py Bumped version; main is now 6.0 pre-alpha. 2025-01-15 22:28:37 +01:00
contents.txt
glossary.txt
index.txt Replaced usage of "patch" with more precise terms in faq, howto, and intro docs. 2024-06-09 14:38:04 -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 Removed unused and unnecessary words from docs/spelling_wordlist. 2024-12-09 09:34:18 +01: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/