mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-08 21:08:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Jacob Walls b325864686 [5.1.x] Fixed #36077 -- Corrected docs on pk value where Model.save() executes an UPDATE. 
The empty string is no longer special-cased since
c2ba59fc1d.

Backport of d66137b39b from main.
2025-01-13 11:20:05 +01: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] Fixed #35999 -- Removed #django IRC channel references where appropriate. 2025-01-08 10:29:52 +01:00
howto [5.1.x] Fixed a typo in docs/howto/static-files/deployment.txt. 2024-11-14 10:35:01 +01:00
internals [5.1.x] Fixed #35999 -- Removed #django IRC channel references where appropriate. 2025-01-08 10:29:52 +01:00
intro [5.1.x] Fixed #35999 -- Removed #django IRC channel references where appropriate. 2025-01-08 10:29:52 +01: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 #36077 -- Corrected docs on pk value where Model.save() executes an UPDATE. 2025-01-13 11:20:05 +01:00
releases [5.1.x] Added stub release notes and release date for 5.1.5, 5.0.11, and 4.2.18. 2025-01-07 12:32:08 -03:00
topics [5.1.x] Removed links to outdated tools in docs/topics/performance.txt. 2024-12-11 16:55:14 -03:00
conf.py [5.1.x] Fixed docs build on Sphinx 8.1+. 2024-10-14 14:44:09 +02: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
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist [5.1.x] Expanded contributor docs on getting feedback from the wider community. 2024-10-16 13:25:43 +02: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/