mirror of
https://github.com/django/django.git
synced 2025-01-27 02:29:55 +00:00
8e8c318449
Follow up to ad6bb20557f5c87de26aeb3afb061af942a8cc17. Backport of 9942a3e49b801b59e10329d86cd8bf12f1716529 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/