django

mirror of https://github.com/django/django.git synced 2024-11-24 20:07:01 +01:00

History

Paolo Melchiorre b5669f08bc Improved the writing documentation contributing guide.		2024-10-25 16:35:35 +02:00
..
_ext	Fixed typo in source file linking Sphinx extension.	2024-07-01 11:32:48 -03:00
_theme
faq	Refs #34900 -- Doc'd Python 3.13 compatibility.	2024-10-09 09:27:33 +02:00
howto	Updated authentication solutions list on using REMOTE_USER how-to.	2024-10-24 09:54:55 +02:00
internals	Improved the writing documentation contributing guide.	2024-10-25 16:35:35 +02:00
intro	Updated tutorial part count from 7 to 8 in docs/intro/reusable-apps.txt.	2024-10-21 14:20:03 -03:00
man
misc
ref	Refs #35803 -- Added support for __covers GIS lookup on MySQL.	2024-10-25 07:55:55 +02:00
releases	Refs #35803 -- Added support for __covers GIS lookup on MySQL.	2024-10-25 07:55:55 +02:00
topics	Fixed #35731 -- Extended db_default docs.	2024-10-23 11:48:30 +02:00
conf.py	Fixed docs build on Sphinx 8.1+.	2024-10-11 17:14:02 +02:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile	Used webbroswer module in docs Makefile.	2024-10-24 10:45:44 +02:00
README.rst
requirements.txt
spelling_wordlist	Expanded contributor docs on getting feedback from the wider community.	2024-10-16 13:23: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/