mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-04-26 10:14:36 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Baptiste Mispelon 08dae5bd46 Refs #35980 -- Updated internal docs for artifact upload and release via admin site. 
Recent updates to djangoproject.com extended the `Release` model to
support uploading and storing artifacts and checksum files. This branch
updates the "How to release Django" docs to match the new release flow.
2025-03-18 22:15:26 -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
Fixed #35908 -- Retired the django-developers and django-users mailing lists.
2025-02-19 12:14:27 +01:00
howto
Fixed #36252 -- Handled duplicate automatic imports in the shell command.
2025-03-17 16:29:28 -03:00
internals
Refs #35980 -- Updated internal docs for artifact upload and release via admin site.
2025-03-18 22:15:26 -03:00
intro
Fixed incorrect formatting for inline pluralized code references in docs.
2025-03-13 15:18:35 -03:00
man
Updated man page for Django 5.2 alpha.
2025-01-15 21:11:20 +01:00
misc
Fixed #35908 -- Retired the django-developers and django-users mailing lists.
2025-02-19 12:14:27 +01:00
ref
Fixed #33497 -- Doc'd that persistent DB connections should be disabled in ASGI and async modes.
2025-03-18 21:26:57 -03:00
releases
Fixed #36234 -- Restored single_object argument to LogEntry.objects.log_actions().
2025-03-12 16:25:28 -03:00
topics
Fixed #33497 -- Doc'd that persistent DB connections should be disabled in ASGI and async modes.
2025-03-18 21:26:57 -03:00
conf.py
Fixed docs build on Sphinx 8.2+.
2025-02-19 09:44:53 +01: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
Fixed #36162 -- Fixed the black Makefile docs rule to work on macOS.
2025-02-01 22:27:38 -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/