mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-12 10:22:37 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
nessita d6a44efa49 [5.2.x] Refs #35612 -- Extended docs on how the security team evaluates reports. 
Co-authored-by: Shai Berger <shai@platonix.com>

Backport of f609a2da868b2320ecdc0551df3cca360d5b5bc3 from main.
2025-02-04 08:55:11 -03: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
[5.2.x] Fixed #36125 -- Switched docs to use chat.djangoproject.com when referencing the Discord server.
2025-01-22 18:23:33 -03:00
howto
[5.2.x] Fixed #36159 -- Removed the empty import example in the custom shell docs.
2025-01-30 12:16:16 +01:00
internals
[5.2.x] Refs #35612 -- Extended docs on how the security team evaluates reports.
2025-02-04 08:55:11 -03:00
intro
[5.2.x] Fixed #36125 -- Switched docs to use chat.djangoproject.com when referencing the Discord server.
2025-01-22 18:23:33 -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
[5.2.x] Tweaked docs to avoid reformatting given new black version.
2025-01-30 10:38:44 -03:00
releases
[5.2.x] Fixed #36140 -- Allowed BaseUserCreationForm to define non required password fields.
2025-02-01 22:50:26 -03:00
topics
Fixed #36070 -- Clarified model validation behavior for composite pks.
2025-01-15 13:44:23 +01:00
conf.py
[5.2.x] Bumped django_next_version in docs config.
2025-01-15 21:19:43 +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
[5.2.x] Fixed #36162 -- Fixed the black Makefile docs rule to work on macOS.
2025-02-01 22:28:35 -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

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/