1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
django/docs
2024-07-23 14:02:30 +02:00
..
_ext Fixed typo in source file linking Sphinx extension. 2024-07-01 11:32:48 -03:00
_theme
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 Replaced usage of "patch" with more precise terms in contributing docs. 2024-07-04 17:52:19 -03:00
intro Refs #35506 -- Reverted "global URLconf" to "root URLconf" in tutorial 1. 2024-07-12 15:09:28 -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 Updated example links in urlize docs. 2024-07-23 14:02:30 +02:00
releases Fixed #35606, Refs #34045 -- Fixed rendering of ModelAdmin.action_checkbox for models with a __html__ method. 2024-07-18 08:09:37 +02:00
topics Relocated database setup details to install docs to simplify tutorial 2. 2024-07-04 15:30:52 -03: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
Makefile
README.rst
requirements.txt
spelling_wordlist Refs #28900 -- Made SELECT respect the order specified by values(*selected). 2024-07-03 16:36:25 +02: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/