1
0
mirror of https://github.com/django/django.git synced 2025-04-16 21:34:37 +00:00
Jacob Walls bf08609501 [3.2.x] Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.
Backport of 1443b5e9aca56e249d751d6486c402b3679d3c38 from main
2021-06-02 08:15:41 +02:00
..
2020-06-03 11:42:42 +02: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), and the `Sphinx`_ documentation system.
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.

.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/