1
0
mirror of https://github.com/django/django.git synced 2024-12-22 09:05:43 +00:00
django/docs
Claude Paroz 4686541691
Migrated setuptools configuration to pyproject.toml.
This branch migrates setuptools configuration from setup.py/setup.cfg to
pyproject.toml. In order to ensure that the generated binary files have
consistent casing (both the tarball and the wheel), setuptools version
is limited to ">=61.0.0,<69.3.0".

Configuration for flake8 was moved to a dedicated .flake8 file since
it cannot be configured via pyproject.toml.

Also, __pycache__ exclusion was removed from MANIFEST and the
extras/Makefile was replaced with a simpler build command.

Co-authored-by: Nick Pope <nick@nickpope.me.uk>
2024-06-24 15:34:43 -03:00
..
_ext Refs #29942 -- Fixed docs build on Python < 3.9 avoiding dict union operator. 2024-05-21 09:15:29 -03:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Replaced usage of "patch" with more precise terms in faq, howto, and intro docs. 2024-06-09 14:38:04 -03:00
howto Replaced usage of "patch" with more precise terms in faq, howto, and intro docs. 2024-06-09 14:38:04 -03:00
internals Migrated setuptools configuration to pyproject.toml. 2024-06-24 15:34:43 -03:00
intro Fixed #35461 -- Updated misleading django-debug-toolbar instructions. 2024-06-21 12:01:34 +02:00
man Updated man page for Django 5.1 alpha. 2024-05-22 11:29:45 -03:00
misc Removed mention of designers in DTL design philosophy. 2024-02-01 09:20:11 +01:00
ref Fixed #35306 -- Documented fallback localization formats in templates when localization is disabled. 2024-06-24 18:06:44 +02:00
releases Fixed #35528 -- Added EmailMultiAlternatives.body_contains() helper method. 2024-06-21 12:00:56 +02:00
topics Migrated setuptools configuration to pyproject.toml. 2024-06-24 15:34:43 -03:00
conf.py Bumped version; main is now 5.2 pre-alpha. 2024-05-22 15:44:07 -03: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 Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01: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 #24018 -- Allowed setting pragma options on SQLite. 2024-02-16 12:59:19 +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/