django

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

History

Nick Pope 69ffb1acf3 Refs #32366 -- Avoided use of datetime.utcnow() in the documentation.		2021-05-12 11:06:31 +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	Refs #32694 -- Clarified when colorama requirement is needed in Windows how-to.	2021-04-29 11:26:38 +02:00
internals	Fixed #32712 -- Deprecated django.utils.baseconv module.	2021-05-07 11:57:40 +02:00
intro	Refs #28034 -- Corrected docs example in contributing tutorial.	2021-04-23 15:24:16 +02:00
man	Updated django-admin man page for Django 3.2.	2021-01-14 14:58:28 +01:00
misc	Expanded API stability docs to include our policy of continual improvement.	2019-11-18 20:37:46 +01:00
ref	Fixed a typo in docs/ref/models/fields.txt.	2021-05-12 11:06:29 +02:00
releases	Refs #32718 -- Corrected CVE-2021-31542 release notes.	2021-05-12 10:42:01 +02:00
topics	Refs #32366 -- Avoided use of datetime.utcnow() in the documentation.	2021-05-12 11:06:31 +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	Added spelling option to make.bat.	2021-04-30 14:04:22 +02:00
Makefile
README.rst	Refs #25778 -- Updated sphinx-doc.org links to HTTPS.	2020-01-29 06:04:15 +01:00
requirements.txt	Used GitHub actions for docs tests.	2021-02-26 22:12:25 +01:00
spelling_wordlist	Fixed #32670 -- Allowed GDALRasters to use any GDAL virtual filesystem.	2021-05-07 20:03:46 +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/