django

mirror of https://github.com/django/django.git synced 2024-12-01 15:42:04 +01:00

History

Adam Johnson ae89daf46f Fixed #31621 -- Added support for '--parallel auto' to test management command.		2021-08-03 09:57:04 +02:00
..
_ext	Refs #32956 -- Corrected spelling of "gray".	2021-08-02 07:51:24 +02:00
_theme	Fixed #32860 -- Made docs permalinks focusable to improve accessibility.	2021-06-21 13:47:26 +02:00
faq	Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.	2021-07-29 06:24:12 +02:00
howto	Refs #32956 -- Updated words ending in -wards.	2021-07-30 20:34:50 +02:00
internals	Refs #32956 -- Updated words ending in -wards.	2021-07-30 20:34:50 +02:00
intro	Clarified URL patterns in tutorial 3.	2021-08-02 08:00:43 +02:00
man	Updated django-admin man page for Django 3.2.	2021-01-14 14:58:28 +01:00
misc	Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.	2021-07-29 06:24:12 +02:00
ref	Fixed #31621 -- Added support for '--parallel auto' to test management command.	2021-08-03 09:57:04 +02:00
releases	Fixed #31621 -- Added support for '--parallel auto' to test management command.	2021-08-03 09:57:04 +02:00
topics	Updated BaseDatabaseFeatures link in testing tools docs.	2021-08-02 12:48:20 +02:00
conf.py	Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.	2021-07-29 06:24:12 +02:00
contents.txt
glossary.txt
index.txt	Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.	2021-07-29 06:24:12 +02:00
make.bat	Added spelling option to make.bat.	2021-04-30 14:04:22 +02:00
Makefile
README.rst
requirements.txt	Used GitHub actions for docs tests.	2021-02-26 22:12:25 +01:00
spelling_wordlist	Refs #32956 -- Updated words ending in -wards.	2021-07-30 20:34:50 +02:00

README.rst

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/