0
0
mirror of https://github.com/django/django.git synced 2024-11-25 07:59:34 +01:00
django/docs
Jon Dufresne d522b51c40 Fixed #31575 -- Added system check for admin sidebar request context processor dependency.
Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
2020-05-14 11:00:51 +02:00
..
_ext Changed '%s' % value pattern to str(value). 2020-05-04 08:27:18 +02:00
_theme
faq Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
howto Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
internals Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
intro Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
man Updated man page for Django 3.1 alpha. 2020-05-12 11:26:37 +02:00
misc
ref Fixed #31575 -- Added system check for admin sidebar request context processor dependency. 2020-05-14 11:00:51 +02:00
releases Refs #31034 -- Documented admin requires django.template.context_processors.request. 2020-05-14 11:00:51 +02:00
topics Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02: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 Refs #31034 -- Documented admin requires django.template.context_processors.request. 2020-05-14 11:00:51 +02: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/