django

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

History

David Smith d0c8b45d4a [5.0.x] Corrected note about using accents in writing documentation contributing guide. Backport of `1611577102` from main		2023-10-21 09:40:04 +02:00
..
_ext	Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+.	2023-08-03 08:01:06 +02:00
_theme
faq
howto	Fixed typo in docs/howto/custom-file-storage.txt.	2023-09-16 07:03:10 +02:00
internals	[5.0.x] Corrected note about using accents in writing documentation contributing guide.	2023-10-21 09:40:04 +02:00
intro	[5.0.x] Reorganized tutorial's part 4 to better understand changes needed in URLConf.	2023-10-10 14:05:36 -03:00
man	Updated man page for Django 5.0 alpha.	2023-09-18 09:25:34 -03:00
misc
ref	[5.0.x] Fixed #34808 -- Doc'd aggregate function's default argument.	2023-10-11 16:10:30 -03:00
releases	[5.0.x] Fixed #34798 -- Fixed QuerySet.aggregate() crash when referencing expressions containing subqueries.	2023-10-16 06:15:08 +02:00
topics	[5.0.x] Fixed #34808 -- Doc'd aggregate function's default argument.	2023-10-11 16:10:30 -03:00
conf.py	[5.0.x] Bumped django_next_version in docs config.	2023-09-18 11:28:22 -03:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist	Added Uyghur language.	2023-08-12 20:37:15 +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/