django

History

Jon Dufresne 28d998a41c Updated isort URL to new location.		2020-12-20 11:00:28 +01:00
..
_ext	Made default_role_error use logger.	2020-06-03 11:42:42 +02:00
_theme	…
faq	…
howto	Fixed #31216 -- Added support for colorama terminal colors on Windows.	2020-11-11 14:27:10 +01:00
internals	Updated isort URL to new location.	2020-12-20 11:00:28 +01:00
intro	Added python_requires/install_requires to setup.cfg example in reusable apps docs.	2020-12-15 07:24:16 +01:00
man	…
misc	Expanded API stability docs to include our policy of continual improvement.	2019-11-18 20:37:46 +01:00
ref	Fixed #32273 -- Doc'd AdminSite.unregister().	2020-12-16 08:08:49 +01:00
releases	Fixed #29867 -- Added support for storing None value in caches.	2020-12-17 09:57:21 +01:00
topics	Refs #30181 -- Corrected note about storing None in the cache.	2020-12-17 09:57:21 +01:00
Makefile	Fixed docs build with Sphinx 1.6.	2017-05-24 09:13:26 -04:00
README.rst	…
conf.py	…
contents.txt	…
glossary.txt	…
index.txt	…
make.bat	…
spelling_wordlist	Fixed #32273 -- Doc'd AdminSite.unregister().	2020-12-16 08:08:49 +01: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/