django

mirror of https://github.com/django/django.git synced 2024-11-29 06:03:25 +01:00

History

Adam Johnson 8cf08a01b5 Improved RegexValidator docs.		2020-06-30 12:44:10 +02:00
..
_ext
_theme	Fixed #16300 -- Improved singlehtml docs formatting with headers CSS.	2020-06-22 21:05:13 +02:00
faq	Removed reference to unsupported versions of Django and Python.	2020-06-03 21:28:14 +02:00
howto	Preferred usage of among/while to amongst/whilst.	2020-06-03 21:02:48 +02:00
internals	Refs #31493 -- Replaced var with const/let in documentation JS.	2020-06-24 12:20:57 +02:00
intro
man
misc
ref	Improved RegexValidator docs.	2020-06-30 12:44:10 +02:00
releases	Fixed #31751 -- Fixed database introspection with cx_Oracle 8.	2020-06-30 09:50:15 +02:00
topics	Refs #31493 -- Replaced var with const/let in documentation JS.	2020-06-24 12:20:57 +02:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
spelling_wordlist	Refs #31670 -- Renamed whitelist argument and attribute of EmailValidator.	2020-06-18 21:43:20 +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/