1
0
mirror of https://github.com/django/django.git synced 2025-04-08 07:26:41 +00:00
Alasdair Nicol 78fc05303a [3.0.x] Refs #30923 -- Fixed an example of rendering templates in contrib.sites docs.
Backport of b991eefd3a9fa4da4eb46fddcb36cf1e8b5862e9 from master
2019-11-05 12:42:04 +01:00
..
2019-11-04 15:18:53 +01:00
2017-05-24 09:13:26 -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 ``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/