p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
django/docs
History
Adam Alton 1e3d8bd3a1 [3.1.x] Removed unnecessary sentence in QuerySet docs. 
Backport of 6e9c5ee88f from master
 		2020-08-07 08:06:21 +02:00
..
_ext [3.1.x] Made default_role_error use logger. 2020-06-03 11:43:37 +02:00
_theme Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags. 2019-12-11 09:49:54 +01:00
faq [3.1.x] Corrected FAQ link in docs/faq/help.txt. 2020-05-29 21:24:21 +02:00
howto [3.1.x] Added Hypercorn to ASGI deployment guide. 2020-08-05 12:15:12 +02:00
internals [3.1.x] Fixed #31842 -- Added DEFAULT_HASHING_ALGORITHM transitional setting. 2020-08-04 09:39:29 +02:00
intro [3.1.x] Updated How to install Django on Windows guide. 2020-06-03 16:28:58 +02:00
man [3.1.x] Updated man page for Django 3.1 beta. 2020-06-15 09:52:09 +02:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref [3.1.x] Removed unnecessary sentence in QuerySet docs. 2020-08-07 08:06:21 +02:00
releases [3.1.x] Fixed #31854 -- Fixed wrapping of long model names in admin's sidebar. 2020-08-05 10:55:11 +02:00
topics [3.1.x] Fixed #31842 -- Added DEFAULT_HASHING_ALGORITHM transitional setting. 2020-08-04 09:39:29 +02:00
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
conf.py [3.1.x] Bumped django_next_version in docs config. 2020-05-12 11:40:57 +02:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
make.bat
…
spelling_wordlist [3.1.x] Added Hypercorn to ASGI deployment guide. 2020-08-05 12:15:12 +02: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/