mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-09 17:02:43 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Natalia 74582b8d11 [4.2.x] Added stub release notes for 4.2.10 and 3.2.24. 
Backport of 06d0a1bd56a9899c351ca047a05813e8dd6a4e17 from main
2024-01-29 12:09:52 -03:00
..
_ext
[4.2.x] Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+.
2023-08-03 09:32:03 +02:00
_theme
Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-05-31 11:17:01 +02:00
faq
[4.2.x] Refs #34118 -- Doc'd Python 3.12 compatibility in Django 4.2.x.
2023-11-19 16:38:33 +01:00
howto
[4.2.x] Removed obsolete sentence in custom model field docs.
2023-11-15 13:53:03 +01:00
internals
[4.2.x] Corrected note about using accents in writing documentation contributing guide.
2023-10-21 09:40:21 +02:00
intro
[4.2.x] Refs #34118 -- Doc'd Python 3.12 compatibility in Django 4.2.x.
2023-11-19 16:38:33 +01:00
man
[4.2.x] Updated man page for Django 4.2 final.
2023-04-03 08:56:48 +02:00
misc
Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.
2021-07-29 06:24:12 +02:00
ref
[4.2.x] Removed link to lawrence.com in contrib.sites docs.
2023-11-28 20:12:09 +01:00
releases
[4.2.x] Added stub release notes for 4.2.10 and 3.2.24.
2024-01-29 12:09:52 -03:00
topics
[4.2.x] Fixed #34970 -- Clarified Password Validation docs regarding the password_changed callback.
2023-11-15 21:51:32 -03:00
conf.py
[4.2.x] Used extlinks for PyPI links.
2023-04-17 07:44:29 +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
[4.2.x] Added Django Forum to mailing lists page.
2023-03-24 08:58:45 +01:00
make.bat
[4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:34:28 +01:00
Makefile
[4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:34:28 +01:00
README.rst
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
requirements.txt
[4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:34:28 +01:00
spelling_wordlist
[4.2.x] Fixed #33405, Refs #7177 -- Clarified docs for filter escapejs regarding safe and unsafe usages.
2023-07-03 13:55:31 +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/