0
0
mirror of https://github.com/django/django.git synced 2024-11-25 07:59:34 +01:00
django/docs
2024-11-17 19:19:14 +01:00
..
_ext
_theme
faq Replaced message suggestions from IRC to Discord in contributing docs. 2024-11-14 11:36:16 +01:00
howto Fixed a typo in docs/howto/static-files/deployment.txt. 2024-11-14 09:46:34 +01:00
internals WIP: Refs #35281 -- Unified and generalized request error handling. 2024-11-17 19:19:14 +01:00
intro Added missing lang attributes to html elements in docs. 2024-10-30 14:02:30 +01:00
man
misc
ref WIP: Refs #35281 -- Unified and generalized request error handling. 2024-11-17 19:19:14 +01:00
releases Made cosmetic edits to 5.2 release notes, including line wrapping at 79 cols. 2024-11-15 23:30:47 -03:00
topics WIP: Refs #35281 -- Unified and generalized request error handling. 2024-11-17 19:19:14 +01:00
conf.py Fixed docs build on Sphinx 8.1+. 2024-10-11 17:14:02 +02:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile Used webbroswer module in docs Makefile. 2024-10-24 10:45:44 +02:00
README.rst
requirements.txt
spelling_wordlist Expanded contributor docs on getting feedback from the wider community. 2024-10-16 13:23:19 +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/