1
0
mirror of https://github.com/django/django.git synced 2024-12-27 19:46:22 +00:00
django/docs
2020-12-29 09:04:35 +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
ref Added app labels to related fields checks messages E302-E305. 2020-12-29 09:01:35 +01:00
releases Fixed #32299 -- Prevented mutating handlers when processing middlewares marking as unused in an async context. 2020-12-29 09:04:35 +01:00
topics Removed forms-MAX_NUM_FORMS POST data in docs 2020-12-23 17:15:48 +01:00
conf.py Bumped version; master is now 3.2 pre-alpha. 2020-05-13 09:07:51 +02:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
spelling_wordlist Fixed #32273 -- Doc'd AdminSite.unregister(). 2020-12-16 08:08:49 +01:00

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/