mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity
01a4d8a3c7
django/docs
History
Mariatta 01a4d8a3c7
Fixed #35737 -- Clarified where "models" comes from in tutorial 7.
2024-09-05 21:37:03 -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 Added references to the Django Discord server inside the FAQ docs. 2024-06-26 12:37:17 +02:00
howto Updated instruction for deploying with Uvicorn and Gunicorn. 2024-09-05 18:32:46 -03:00
internals Fixed #35666 -- Documented stacklevel usage and testing, and adjusted test suite accordingly. 2024-08-28 11:44:05 -03:00
intro Fixed #35737 -- Clarified where "models" comes from in tutorial 7. 2024-09-05 21:37:03 -03: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 Fixed CVE-2024-45231 -- Avoided server error on password reset when email sending fails. 2024-09-03 09:22:32 -03:00
releases Added CVE-2024-45230 and CVE-2024-45231 to security archive. 2024-09-03 11:19:02 -03:00
topics Fixed CVE-2024-45231 -- Avoided server error on password reset when email sending fails. 2024-09-03 09:22:32 -03:00
conf.py Removed unnecessary trailing slashes in Sphinx intersphinx_mapping URLs. 2024-08-23 11:15:16 -03:00
contents.txt
glossary.txt
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 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 Refs #28900 -- Made SELECT respect the order specified by values(*selected). 2024-07-03 16:36:25 +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/