django

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

History

Carlton Gibson 966ed414b2 Added stub release notes for 3.1.6.		2021-01-04 08:58:03 +01:00
..
_ext	Made default_role_error use logger.	2020-06-03 11:42:42 +02:00
_theme	Fixed #16300 -- Improved singlehtml docs formatting with headers CSS.	2020-06-22 21:05:13 +02:00
faq	Refs #31040 -- Doc'd Python 3.9 compatibility.	2020-10-13 08:35:01 +02:00
howto	Fixed #31216 -- Added support for colorama terminal colors on Windows.	2020-11-11 14:27:10 +01:00
internals	Refs #30367 -- Changed remaining "pip install" to "python -m pip install" in docs.	2020-12-23 17:21:25 +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	Updated man page for Django 3.1 alpha.	2020-05-12 11:26:37 +02:00
misc	Expanded API stability docs to include our policy of continual improvement.	2019-11-18 20:37:46 +01:00
ref	Refs #28741 -- Doc'd SESSION_COOKIE_DOMAIN requirement with CSRF_USE_SESSIONS.	2021-01-04 07:49:30 +01:00
releases	Added stub release notes for 3.1.6.	2021-01-04 08:58:03 +01:00
topics	Removed forms-MAX_NUM_FORMS POST data in docs	2020-12-23 17:15:48 +01:00
conf.py	Updated CVE URL.	2021-01-02 12:49:00 +01:00
contents.txt
glossary.txt
index.txt	Fixed #25712 -- Reorganized templates docs.	2020-04-30 08:12:09 +02:00
make.bat
Makefile	Fixed docs build with Sphinx 1.6.	2017-05-24 09:13:26 -04:00
README.rst	Refs #25778 -- Updated sphinx-doc.org links to HTTPS.	2020-01-29 06:04:15 +01:00
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/