mirror of
https://github.com/django/django.git
synced 2025-04-15 12:54:38 +00:00
5d9be66c98
The note on a possible race condition is inappropriate in this tutorial setting. To quote Diátaxis: > Your job is to guide the learner to a successful conclusion. There > may be many interesting diversions along the way … - ignore them. Co-Authored-By: Ryan Hiebert <ryan@ryanhiebert.com> Backport of 0a646c8e08605ba6896ef8f2938231d23c2181cc 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/