mirror of
https://github.com/django/django.git
synced 2025-03-12 10:22:37 +00:00
d9f37ac118
Previously, this was a bare list of sub-pages, not in any discernible order, and hard to parse. Now the sub-pages are grouped in sections by topic. It's unlikely to be the final word on how this material is arranged, but it's a clear improvement on the existing arrangement and provides a good basis for next steps. Backport of dd0a116b93c40f9febf0e09614ad666af1191744 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/