django

mirror of https://github.com/django/django.git synced 2024-12-27 03:25:58 +00:00

History

Mariusz Felisiak 67fe092a85 [4.2.x] Fixed typo in docs/ref/models/querysets.txt. Backport of `c4a09499aa` from main		2023-06-27 12:54:46 +02:00
..
_ext
_theme
faq	[4.2.x] Fixed #34545 -- Corrected the number of months in installation FAQ.	2023-05-08 08:34:47 +02:00
howto	[4.2.x] Updated broken links in docs.	2023-05-17 12:13:40 +02:00
internals	[4.2.x] Refs #30220 -- Bumped required version of Selenium to 3.8.0.	2023-06-13 10:13:15 +02:00
intro	[4.2.x] Fixed #34579 -- Added Django Forum to contributing guides.	2023-05-23 06:00:02 +02:00
man	[4.2.x] Updated man page for Django 4.2 final.	2023-04-03 08:56:48 +02:00
misc
ref	[4.2.x] Fixed typo in docs/ref/models/querysets.txt.	2023-06-27 12:54:46 +02:00
releases	[4.2.x] Added stub release notes and release date for 4.2.3, 4.1.10, and 3.2.20.	2023-06-26 14:36:06 +02:00
topics	[4.2.x] Fixed typo in docs/topics/db/fixtures.txt.	2023-06-16 19:34:32 +02:00
conf.py	[4.2.x] Used extlinks for PyPI links.	2023-04-17 07:44:29 +02:00
contents.txt
glossary.txt
index.txt	[4.2.x] Added Django Forum to mailing lists page.	2023-03-24 08:58:45 +01:00
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist	[4.2.x] Fixed #34574 -- Noted unexpected outcomes in autoescape/escape docs.	2023-05-26 07:50:19 +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/