mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-05-29 10:16:30 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Ahmed Nassar aa2c7659d5 [5.2.x] Fixed #35993 -- Documented gettext f-string support limitations. 
Thank you to Claude Paroz and Athena Wolfskämpf for the review.

Backport of 2c2f09055579cc6068cae6c6fd3135011d6df4f1 from main.
2025-04-15 10:03:41 +02: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 #35908 -- Retired the django-developers and django-users mailing lists.
2025-02-19 12:16:20 +01:00
howto
[5.2.x] Fixed #36252 -- Handled duplicate automatic imports in the shell command.
2025-03-17 16:30:31 -03:00
internals
[5.2.x] Fixes #36215 -- Included unpacking generalization notes in coding style guide (PEP-448).
2025-03-31 22:44:35 -03:00
intro
[5.2.x] Simplified Intersphinx configuration example.
2025-03-28 09:37:40 +01:00
man
[5.2.x] Updated man page for Django 5.2 final.
2025-04-02 14:47:20 +02:00
misc
[5.2.x] Fixed #35908 -- Retired the django-developers and django-users mailing lists.
2025-02-19 12:16:20 +01:00
ref
[5.2.x] Clarified url and name arguments in flatpages URLconf ref docs.
2025-04-08 22:03:15 -03:00
releases
[5.2.x] Fixed #36288 -- Addressed improper handling of duplicates in values_list().
2025-04-11 09:06:53 +02:00
topics
[5.2.x] Fixed #35993 -- Documented gettext f-string support limitations.
2025-04-15 10:03:41 +02:00
conf.py
[5.2.x] Fixed #36320 -- Ignored "duplicated_toc_entry" for ePub docs build.
2025-04-12 19:39:32 +02:00
contents.txt
Fixed #26020 -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
glossary.txt
Fixed #26020 -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
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
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
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/