1
0
mirror of https://github.com/django/django.git synced 2025-03-06 15:32:33 +00:00
Maria Hynes 163e72ebba Removed unneeded OS reference on running the test suite in contributing docs.
This is not needed as the console snippet has buttons that allows the user to choose their OS.
2024-10-29 11:34:35 +01:00
..
2024-10-29 11:17:37 +01:00
2024-10-11 17:14:02 +02: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/