mirror of
https://github.com/django/django.git
synced 2025-03-09 08:52:32 +00:00
Thanks James Ostrander for the report and fix, and to Tim Graham and Mariusz Felisiak for the reviews. Backport of 36b7024b7fc881b319a2b67876e4f72ba680d6a8 from main
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/