1
0
mirror of https://github.com/django/django.git synced 2024-12-28 03:55:50 +00:00
django/docs
2023-10-09 11:51:32 +02:00
..
_ext Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 08:01:06 +02:00
_theme
faq
howto Fixed typo in docs/howto/custom-file-storage.txt. 2023-09-16 07:03:10 +02:00
internals [5.0.x] Refs #34043 -- Clarified how to test UI changes. 2023-10-09 11:51:32 +02:00
intro [5.0.x] Refs #34043 -- Clarified how to test UI changes. 2023-10-09 11:51:32 +02:00
man Updated man page for Django 5.0 alpha. 2023-09-18 09:25:34 -03:00
misc
ref [5.0.x] Added missing import in docs/ref/contrib/contenttypes.txt. 2023-10-07 06:59:24 +02:00
releases [5.0.x] Added backticks to setuptools in docs. 2023-10-09 09:56:26 +02:00
topics [5.0.x] Fixed #32602 -- Clarified wording of TestCase class. 2023-10-02 11:49:00 +02: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
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist Added Uyghur language. 2023-08-12 20:37:15 +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/