mirror of
https://github.com/django/django.git
synced 2025-04-18 06:14:37 +00:00
The format changed in 22bfc451467ec6e13044a87a97cf00e9f8a845e4. Backport of 7060f777b09da2a844820a39f227a420c2c6ff90 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/