mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-04-16 21:34:37 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
ssanger 08c0c42139 [5.1.x] Fixed #35863 -- Replaced bold text with heading level 3 in new contributors docs. 
This improves accessibility for screen reader users, see WCAG SC 1.3.1 Info and Relationships:
https://www.w3.org/WAI/WCAG22/Understanding/info-and-relationships.html

Backport of c4c076223eb73553d3bc8fbc11be2c529d9aea6b from main.
2024-11-06 17:05:37 +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] Refs #34900 -- Doc'd Python 3.13 compatibility.
2024-10-09 09:56:42 +02:00
howto
[5.1.x] Updated authentication solutions list on using REMOTE_USER how-to.
2024-10-24 10:03:45 +02:00
internals
[5.1.x] Fixed #35863 -- Replaced bold text with heading level 3 in new contributors docs.
2024-11-06 17:05:37 +01:00
intro
[5.1.x] Added missing lang attributes to html elements in docs.
2024-10-30 14:04:37 +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 #35889 -- Corrected reference of default widgets in "Styling widget instance" docs.
2024-11-06 13:09:31 +01:00
releases
[5.1.x] Added stub release notes for 5.1.4.
2024-11-05 06:32:04 +01:00
topics
[5.1.x] Added missing lang attributes to html elements in docs.
2024-10-30 14:04:37 +01:00
conf.py
[5.1.x] Fixed docs build on Sphinx 8.1+.
2024-10-14 14:44:09 +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
[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
[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/