0
0
mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00
django/docs
2024-07-03 16:28:17 +02: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 Fixed #35511 -- Documented when the py binary is unavailable on Windows. 2024-07-03 16:28:17 +02:00
internals Refs #22712 -- Corrected deprecation of "all" argument in django.contrib.staticfiles.finders.find(). 2024-06-28 08:39:55 -03:00
intro Refs #35380 -- Updated screenshots in intro docs. 2024-06-25 17:45:20 -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 #23790 -- Warned about renaming AppConfig.label in docs/ref/applications.txt. 2024-07-01 21:52:04 -03:00
releases Fixed #22712 -- Avoided name shadowing of "all" in django.contrib.staticfiles.finders. 2024-06-27 23:37:12 -03:00
topics Fixed #34886 -- Modified sample use of lazy in delayed translations. 2024-06-25 08:59:38 +02:00
conf.py Bumped version; main is now 5.2 pre-alpha. 2024-05-22 15:44:07 -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
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Fixed #24018 -- Allowed setting pragma options on SQLite. 2024-02-16 12:59:19 +01:00

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/