mirror of
https://github.com/django/django.git
synced 2025-04-08 07:26:41 +00:00
Follow up to 97d3321e89c8d4434927bdbc308db1ccffa99d3b. Backport of e5cacb1f47cb3a2943bbc7685a630c84503b0d1b from master
The documentation in this tree is in plain text files and can be viewed using any text file viewer. It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2]. 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. [1] http://docutils.sourceforge.net/rst.html [2] http://sphinx-doc.org/