mirror of
https://github.com/django/django.git
synced 2025-01-30 03:59:19 +00:00
0dc986d1c8
Thanks Tuttle for the report and draft patch, and Carl Meyer for help and review. Backport of c633667da3605208ea5fc137f5322c599f48da69 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 ``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/