p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
django/docs
History
David Sanders a7be74d017 [3.2.x] Clarified type of Window()'s partition_by and order_by arguments. 
Backport of ecf76cc1fb from main
 		2021-09-10 12:27:55 +02:00
..
_ext Made default_role_error use logger. 2020-06-03 11:42:42 +02:00
_theme [3.2.x] Fixed #32860 -- Made docs permalinks focusable to improve accessibility. 2021-06-21 14:07:27 +02:00
faq [3.2.x] Fixed some broken links and redirects in docs. 2021-08-09 07:09:37 +02:00
howto [3.2.x] Used backend vendors in custom model fields docs. 2021-08-24 16:17:13 +02:00
internals [3.2.x] The django-i18n mailing list moved to the Django Forum. 2021-08-13 15:36:25 +02:00
intro [3.2.x] Made sentence about Model consistent in docs. 2021-08-26 09:05:43 +02:00
man [3.2.x] Updated manpage for Django 3.2 final. 2021-04-06 11:02:06 +02:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref [3.2.x] Clarified type of Window()'s partition_by and order_by arguments. 2021-09-10 12:27:55 +02:00
releases [3.2.x] Added stub release notes for Django 3.2.8. 2021-09-01 09:51:50 +02:00
topics [3.2.x] Refs #31055 -- Doc'd 'databases' argument of check functions. 2021-09-10 11:48:20 +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.2.x] Refs #31676 -- Removed Django Core-Mentorship mailing list references in docs. 2021-07-13 20:22:17 +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 [3.2.x] Added spelling option to make.bat. 2021-04-30 14:09:59 +02:00
spelling_wordlist [3.2.x] Changed IRC references to Libera.Chat. 2021-05-20 12:25:07 +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/