django

mirror of https://github.com/django/django.git synced 2024-12-28 20:16:19 +00:00

History

David Sanders 5685b7cd73 Fixed typos in comments and docs.		2021-05-29 12:51:14 +02:00
..
_ext
_theme
faq	Changed IRC references to Libera.Chat.	2021-05-20 12:23:36 +02:00
howto	Refs #32720 -- Updated various links in docs to avoid redirects and use HTTPS.	2021-05-17 09:46:09 +02:00
internals	Fixed typo in MiddlewareMixin deprecation note.	2021-05-27 06:17:30 +02:00
intro	Changed IRC references to Libera.Chat.	2021-05-20 12:23:36 +02:00
man
misc
ref	Fixed typos in comments and docs.	2021-05-29 12:51:14 +02:00
releases	Fixed #32676 -- Prevented migrations from rendering related field attributes when not passed during initialization.	2021-05-28 20:25:59 +02:00
topics	Fixed typos in comments and docs.	2021-05-29 12:51:14 +02:00
conf.py	Changed IRC references to Libera.Chat.	2021-05-20 12:23:36 +02:00
contents.txt
glossary.txt
index.txt
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	Changed IRC references to Libera.Chat.	2021-05-20 12:23:36 +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/