mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-27 11:35:53 +00:00
Code Issues 30 Releases Wiki Activity
e72fdc850a
django/docs
History
sandjio e72fdc850a [5.0.x] Fixed #35153 -- Added note about locale name notation to FORMAT_MODULE_PATH docs. 
Co-authored-by: Paul Hermans <paul.hermans@benemtech.com>

Backport of 9bd849c8d5 from main
2024-02-20 06:11:51 +01:00
..
_ext [5.0.x] Applied Black's 2024 stable style. 2024-01-26 12:55:56 +01:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq [5.0.x] Updated examples for 2.0+ release numbering in installation FAQ. 2023-12-15 06:17:02 +01:00
howto [5.0.x] Corrected BaseCommand.check() signature in docs. 2024-01-30 11:41:26 +01:00
internals [5.0.x] Fixed typo in docs/internals/contributing/writing-code/coding-style.txt. 2024-02-08 05:58:49 +01:00
intro [5.0.x] Applied Black's 2024 stable style. 2024-01-26 12:55:56 +01:00
man [5.0.x] Updated man page for Django 5.0 rc1. 2023-11-20 08:46:20 -03:00
misc [5.0.x] Removed mention of designers in DTL design philosophy. 2024-02-01 09:20:53 +01:00
ref [5.0.x] Fixed #35153 -- Added note about locale name notation to FORMAT_MODULE_PATH docs. 2024-02-20 06:11:51 +01:00
releases [5.0.x] Fixed #35187 -- Fixed @sensitive_variables/sensitive_post_parameters decorators crash with .pyc-only builds. 2024-02-17 08:16:36 +01:00
topics [5.0.x] Fixed typo in docs/topics/db/managers.txt. 2024-02-01 09:26:24 +01:00
conf.py [5.0.x] Bumped django_next_version in docs config. 2023-09-18 11:28:22 -03:00
contents.txt
glossary.txt
index.txt Added Django Forum to mailing lists page. 2023-03-24 08:32:17 +01: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.0.x] Doc'd support for assistive technologies in the admin. 2023-11-17 11:20:54 +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/