mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-13 02:40:47 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Clifford Gama bf45f06769 [5.1.x] Refs #35060 -- Fixed the update to update_fields in overridden save() method docs. 
Regression in 3915d4c70d0d7673abe675525b58117a5099afd3.

Backport of 38c206515494cb28c48f77c10145a8aa9a172629 from main.
2024-09-11 13:25:21 +02:00
..
_ext
[5.1.x] Fixed typo in source file linking Sphinx extension.
2024-07-01 11:33:45 -03:00
_theme
Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-05-31 11:17:01 +02:00
faq
[5.1.x] Added references to the Django Discord server inside the FAQ docs.
2024-06-26 12:39:25 +02:00
howto
[5.1.x] Updated instruction for deploying with Uvicorn and Gunicorn.
2024-09-05 18:33:52 -03:00
internals
[5.1.x] Fixed #35666 -- Documented stacklevel usage and testing, and adjusted test suite accordingly.
2024-08-28 11:47:15 -03:00
intro
[5.1.x] Fixed #35737 -- Clarified where "models" comes from in tutorial 7.
2024-09-05 21:37:46 -03: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
[5.1.x] Fixed #35681 -- Corrected geoip2 docs when describing GeoIP2Exception.
2024-09-07 00:04:59 -03:00
releases
[5.1.x] Added CVE-2024-45230 and CVE-2024-45231 to security archive.
2024-09-03 11:24:09 -03:00
topics
[5.1.x] Refs #35060 -- Fixed the update to update_fields in overridden save() method docs.
2024-09-11 13:25:21 +02:00
conf.py
[5.1.x] Bumped django_next_version in docs config.
2024-05-22 11:34:04 -03:00
contents.txt
…
glossary.txt
…
index.txt
[5.1.x] Replaced usage of "patch" with more precise terms in faq, howto, and intro docs.
2024-06-09 14:40:18 -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
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
requirements.txt
Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:02:57 +01:00
spelling_wordlist
Added counterintuitive to the spelling wordlist to fix docs build error.
2024-07-08 22:36:33 -03: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/