1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
2020-06-13 00:06:29 +02:00
..
_ext Made default_role_error use logger. 2020-06-03 11:42:42 +02:00
_theme Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags. 2019-12-11 09:49:54 +01:00
faq Removed reference to unsupported versions of Django and Python. 2020-06-03 21:28:14 +02:00
howto Preferred usage of among/while to amongst/whilst. 2020-06-03 21:02:48 +02:00
internals Fixed #31643 -- Changed virtualenv doc references to Python 3 venv. 2020-06-02 11:45:44 +02:00
intro Updated How to install Django on Windows guide. 2020-06-03 16:28:10 +02:00
man Updated man page for Django 3.1 alpha. 2020-05-12 11:26:37 +02:00
misc
ref Fixed #31691 -- Added ordering support to JSONBAgg. 2020-06-13 00:06:29 +02:00
releases Fixed #31691 -- Added ordering support to JSONBAgg. 2020-06-13 00:06:29 +02:00
topics Fixed #20347 -- Allowed customizing the maximum number of instantiated forms in formsets. 2020-06-05 12:01:32 +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 Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
make.bat
Makefile
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
spelling_wordlist Added support for the Tajik language. 2020-06-12 17:47:22 +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/