django

mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00

History

Carlton Gibson 6a7af38b07 Added note to update docs config when creating new stable branch. django_next_version in docs/conf.py should be bumped when creating a new stable branch.		2021-04-22 08:08:38 +02: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	Fixed #32652 -- Fixed links to new contributors FAQ.	2021-04-15 17:14:22 +02:00
howto	Fixed #32667 -- Added link to labeling checks in BaseCommand.requires_system_checks docs.	2021-04-21 16:40:04 +02:00
internals	Added note to update docs config when creating new stable branch.	2021-04-22 08:08:38 +02:00
intro	Updated Git branch "master" to "main".	2021-03-09 08:48:32 +01:00
man	Updated django-admin man page for Django 3.2.	2021-01-14 14:58:28 +01:00
misc
ref	Fixed #32574 -- Confirmed support for PROJ 8.x.	2021-04-19 20:13:43 +02:00
releases	Fixed #32650 -- Fixed handling subquery aliasing on queryset combination.	2021-04-21 09:49:15 +02:00
topics	Fixed #32667 -- Added link to labeling checks in BaseCommand.requires_system_checks docs.	2021-04-21 16:40:04 +02:00
conf.py	Updated Git branch "master" to "main".	2021-03-09 08:48:32 +01: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
requirements.txt	Used GitHub actions for docs tests.	2021-02-26 22:12:25 +01:00
spelling_wordlist	Fixed #31840 -- Added support for Cross-Origin Opener Policy header.	2021-03-30 19:59:24 +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/