1
0
mirror of https://github.com/django/django.git synced 2025-04-03 21:16:44 +00:00
Michiel Beijen 7eecf496ee [1.11.x] Renamed "Mac OS X" to "macOS" in docs.
Backport of 5e8625ba643db118a44cb32e9e48bf431ef4da53 from master
2017-04-24 20:51:55 -04:00
..
2014-09-22 15:49:48 -04:00

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/