django

History

Kal Sze aa6c620249 More accurate terminology ("logger" instead of "logging handler") in logging documentation.		2020-01-09 15:27:34 +01:00
..
_ext	Fixed #31025 -- Fixed highlightlinenothreshold deprecation warning on Sphinx 1.8+.	2019-11-25 10:33:33 +01:00
_theme	Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags.	2019-12-11 09:49:54 +01:00
faq	Fixed #23433 -- Deprecated django-admin.py entry point in favor of django-admin.	2019-12-06 12:11:44 +01:00
howto	Refs #30767 -- Improved deployment documentation.	2019-12-20 10:42:56 +01:00
internals	Added guidelines for assertIs() usage.	2019-12-30 11:25:18 +01:00
intro	Removed "Don't do that" from docs and error messages.	2020-01-06 13:50:43 +01:00
man	…
misc	…
ref	Fixed #31118 -- Made FileInput to avoid the required attribute when initial data exists.	2020-01-08 09:15:31 +01:00
releases	Fixed #30995 -- Allowed converter.to_url() to raise ValueError to indicate no match.	2020-01-09 14:41:41 +01:00
topics	More accurate terminology ("logger" instead of "logging handler") in logging documentation.	2020-01-09 15:27:34 +01:00
Makefile	Fixed docs build with Sphinx 1.6.	2017-05-24 09:13:26 -04:00
README.rst	Improved ReST formatting in docs/README.rst.	2020-01-09 14:10:27 +01:00
conf.py	…
contents.txt	…
glossary.txt	…
index.txt	Fixed typo in docs/index.txt.	2020-01-03 07:53:31 +01:00
make.bat	…
spelling_wordlist	Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable.	2019-12-03 17:29:31 +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: http://sphinx-doc.org